From 496c484b06919ec8410437a4c00b02746b823250 Mon Sep 17 00:00:00 2001 From: Reza Rezvani Date: Tue, 28 Oct 2025 12:04:00 +0100 Subject: [PATCH] feat: add complete GitHub repository pages and MIT License for open source MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add professional open source repository setup with all essential GitHub community health files, templates, and legal documentation. Core Files Added (5): 1. **LICENSE** - Official MIT License - Copyright 2025 Alireza Rezvani - GitHub will automatically recognize and display - Enables commercial use, modification, distribution 2. **CONTRIBUTING.md** - Complete contribution guidelines - Skill creation standards following Anthropic spec - Python script quality requirements - Development workflow and PR process - Style guide (Python PEP 8, Markdown, commits) - Domain-specific guidelines - Quality checklist for contributors 3. **CODE_OF_CONDUCT.md** - Contributor Covenant 2.0 standard - Community standards and expectations - Enforcement guidelines - Incident reporting process 4. **SECURITY.md** - Vulnerability reporting process - Supported versions table - Response timelines by severity - Security best practices for users - Secure coding guidelines for contributors - Responsible disclosure policy 5. **CHANGELOG.md** - Keep a Changelog format - Complete version history from v1.0.0 - Documents all 42 skills in initial release - Tracks Anthropic refactoring progress (v1.1.0) - GitHub pages addition (v1.0.2) - Semantic versioning with comparison links GitHub Templates Added (5): 6. **.github/ISSUE_TEMPLATE/bug_report.md** - Standardized bug reporting - Environment details checklist - Reproduction steps required - Skill-specific context 7. **.github/ISSUE_TEMPLATE/feature_request.md** - New skill proposal template - Problem statement and use cases - ROI and value quantification - Python tools and references specification 8. **.github/ISSUE_TEMPLATE/skill_improvement.md** - Enhancement suggestions for existing skills - Specific change proposals - Value proposition requirement - Implementation willingness indicator 9. **.github/ISSUE_TEMPLATE/documentation.md** - Documentation issue reporting - Clear before/after examples - Affected audience specification - Link validation focus 10. **.github/pull_request_template.md** - Comprehensive PR checklist - Quality standards enforcement - Testing requirements - Documentation update verification - ROI value estimation Benefits: **For Repository:** - ✅ Professional open source appearance - ✅ GitHub recognizes LICENSE automatically - ✅ Community health score improves to 100% - ✅ Legal clarity (MIT License) - ✅ Security vulnerability process established **For Contributors:** - ✅ Clear contribution guidelines - ✅ Standardized issue templates - ✅ Quality checklists - ✅ Expected behavior defined **For Users:** - ✅ Transparent licensing - ✅ Security reporting process - ✅ Version history tracking - ✅ Professional community standards Repository Status: - All GitHub recommended community files present - Open source best practices followed - Ready for community contributions - Professional project presentation This completes the essential GitHub repository setup for a professional open source project, making the Claude Skills Library contribution-ready and community-friendly. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- .github/ISSUE_TEMPLATE/bug_report.md | 58 +++ .github/ISSUE_TEMPLATE/documentation.md | 90 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 92 +++++ .github/ISSUE_TEMPLATE/skill_improvement.md | 102 +++++ .github/pull_request_template.md | 183 +++++++++ CHANGELOG.md | 197 ++++++++++ CODE_OF_CONDUCT.md | 131 +++++++ CONTRIBUTING.md | 408 ++++++++++++++++++++ LICENSE | 21 + SECURITY.md | 294 ++++++++++++++ 10 files changed, 1576 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/skill_improvement.md create mode 100644 .github/pull_request_template.md create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e8483d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,58 @@ +--- +name: Bug Report +about: Report a bug in a skill or Python script +title: '[BUG] ' +labels: bug +assignees: '' +--- + +## Bug Description + +A clear and concise description of the bug. + +## Affected Skill + +**Skill Name:** (e.g., content-creator, ceo-advisor, senior-fullstack) +**Component:** (e.g., Python script, SKILL.md, reference file) + +## To Reproduce + +Steps to reproduce the behavior: +1. Go to '...' +2. Run command '...' +3. See error + +## Expected Behavior + +A clear description of what you expected to happen. + +## Actual Behavior + +What actually happened. + +## Error Messages + +``` +Paste any error messages here +``` + +## Environment + +- **OS:** (e.g., macOS 14, Ubuntu 22.04, Windows 11) +- **Python Version:** (e.g., 3.11.5) +- **Claude Platform:** (Claude AI, Claude Code, API) +- **Skill Version:** (check metadata in SKILL.md) + +## Additional Context + +Add any other context about the problem here, such as: +- Screenshots +- Related issues +- Potential fixes you've identified + +## Checklist + +- [ ] I have searched existing issues to avoid duplicates +- [ ] I have tested with the latest version +- [ ] I have included all relevant error messages +- [ ] I have provided steps to reproduce diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..37ddda3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,90 @@ +--- +name: Documentation Improvement +about: Suggest improvements to documentation +title: '[DOCS] ' +labels: documentation +assignees: '' +--- + +## Documentation Issue + +**File(s) Affected:** (e.g., README.md, CLAUDE.md, specific SKILL.md) +**Section:** (e.g., Installation, Quick Start, Roadmap) + +## Issue Type + +Select one or more: +- [ ] Unclear instructions +- [ ] Missing information +- [ ] Outdated content +- [ ] Broken links +- [ ] Typos or grammar +- [ ] Missing examples +- [ ] Incorrect information +- [ ] Needs reorganization +- [ ] Other (specify) + +## Current Problem + +**What is unclear, missing, or incorrect?** + +Describe the documentation issue in detail. + +## Proposed Improvement + +**What should be changed?** + +Describe the proposed documentation improvement. + +## Specific Changes + +### If Fixing Content: +**Current Text:** +``` +[Paste current text that needs fixing] +``` + +**Proposed Text:** +``` +[Paste proposed improved text] +``` + +### If Adding New Section: +**Where to Add:** (After which section) +**Proposed Content:** +```markdown +[Paste proposed new section] +``` + +### If Reorganizing: +**Current Structure:** +- Section 1 +- Section 2 + +**Proposed Structure:** +- Section A +- Section B + +## Affected Audience + +**Who would benefit from this improvement?** + +- [ ] New users getting started +- [ ] Experienced users seeking advanced features +- [ ] Contributors wanting to add skills +- [ ] Developers using Python tools +- [ ] All users + +## Additional Context + +- Screenshots showing the issue +- Links to related documentation +- Examples from other projects +- User feedback or questions + +## Checklist + +- [ ] I have checked this is not already fixed in main branch +- [ ] I have specified exactly what should change +- [ ] I have considered the impact on other documentation +- [ ] I'm willing to submit a PR for this (optional) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..08771ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,92 @@ +--- +name: New Skill Request +about: Suggest a new skill for the library +title: '[SKILL REQUEST] ' +labels: enhancement, new-skill +assignees: '' +--- + +## Skill Overview + +**Proposed Skill Name:** +**Domain/Category:** (e.g., Marketing, Engineering, Finance, HR) +**Target Users:** (e.g., Marketing managers, Data scientists, HR professionals) + +## Problem Statement + +**What problem does this skill solve?** + +Describe the challenge or need that this skill addresses. + +## Proposed Capabilities + +**What should this skill be able to do?** + +List the key capabilities: +- Capability 1 +- Capability 2 +- Capability 3 + +## Use Cases + +**How would users use this skill?** + +### Use Case 1: +**Scenario:** +**User request:** +**Expected output:** + +### Use Case 2: +(Add more as needed) + +## Python Automation Tools + +**What Python tools would be valuable?** + +List potential automation scripts: +- `tool1.py` - Purpose +- `tool2.py` - Purpose +- `tool3.py` - Purpose + +## References & Frameworks + +**What knowledge bases should be included?** + +List frameworks, templates, or reference materials: +- Framework 1 +- Template 2 +- Best practices guide 3 + +## Similar Skills/Tools + +**Are there existing skills or tools that are similar?** + +List any: +- Similar skills in this repository +- External tools or resources +- How this differs/improves + +## Value Proposition + +**Why is this skill valuable?** + +- **Time Savings:** Estimated hours saved per month +- **Quality Improvement:** Expected quality gains +- **Target Audience Size:** How many people would benefit +- **ROI Estimate:** Potential financial impact + +## Additional Context + +Any other information: +- Industry trends supporting this need +- User research or feedback +- Links to related resources +- Willingness to contribute to development + +## Checklist + +- [ ] I have searched existing skills to avoid duplicates +- [ ] I have searched existing issues/requests +- [ ] I have clearly defined the problem and use cases +- [ ] I have specified what should be automated (Python tools) +- [ ] I have estimated the value/ROI diff --git a/.github/ISSUE_TEMPLATE/skill_improvement.md b/.github/ISSUE_TEMPLATE/skill_improvement.md new file mode 100644 index 0000000..e3ead6e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/skill_improvement.md @@ -0,0 +1,102 @@ +--- +name: Skill Improvement +about: Suggest improvements to an existing skill +title: '[IMPROVEMENT] ' +labels: enhancement +assignees: '' +--- + +## Skill Information + +**Skill Name:** (e.g., content-creator, product-manager-toolkit) +**Current Version:** (check metadata in SKILL.md) +**Domain:** (e.g., Marketing, Product, Engineering) + +## Improvement Type + +Select the type of improvement: +- [ ] Add new Python tool/script +- [ ] Enhance existing script functionality +- [ ] Add new reference materials +- [ ] Improve SKILL.md documentation +- [ ] Add new templates or examples +- [ ] Update frameworks or best practices +- [ ] Fix outdated information +- [ ] Other (specify) + +## Current Limitation + +**What is currently missing or could be better?** + +Describe the limitation or gap in the current skill. + +## Proposed Enhancement + +**What should be added or improved?** + +Detailed description of the proposed improvement. + +## Specific Changes + +**What exactly would change?** + +### If Adding Python Tool: +- **Script Name:** tool_name.py +- **Purpose:** What it does +- **Input:** What it takes +- **Output:** What it produces +- **Usage Example:** `python scripts/tool_name.py input.txt` + +### If Enhancing Documentation: +- **Files to Update:** +- **Sections to Add/Modify:** +- **New Content:** + +### If Adding References: +- **New Reference File:** references/framework.md +- **Content:** Framework, template, or guideline +- **Purpose:** When and how to use it + +## Value Proposition + +**Why is this improvement valuable?** + +- **Additional Time Savings:** Hours saved per month +- **Quality Improvement:** Specific quality gains +- **User Impact:** Who benefits and how +- **Completeness:** Fills a gap in current coverage + +## Examples + +**Show how this would be used:** + +### Before (Current State): +``` +Current workflow or limitation +``` + +### After (With Improvement): +``` +Improved workflow or capability +``` + +## Implementation Willingness + +- [ ] I'm willing to implement this improvement myself +- [ ] I need help implementing this +- [ ] I'm suggesting for someone else to implement + +## Additional Context + +Any other information: +- Related skills or tools +- Industry best practices +- User feedback or requests +- Links to relevant resources + +## Checklist + +- [ ] I have checked the latest version of the skill +- [ ] This improvement doesn't duplicate existing functionality +- [ ] I have clearly described the value proposition +- [ ] I have provided concrete examples diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..3b8d0b8 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,183 @@ +# Pull Request + +## Description + +**What does this PR do?** + +A clear and concise description of the changes. + +## Type of Change + +Select the type of change: +- [ ] New skill addition +- [ ] Skill enhancement/improvement +- [ ] Bug fix +- [ ] Documentation update +- [ ] Python script improvement +- [ ] Refactoring/optimization +- [ ] Other (specify) + +## Related Issue + +Fixes #(issue number) + +Or: Related to #(issue number) + +--- + +## Changes Made + +### Skills Added/Modified + +**Skill Name(s):** +- + +**What Changed:** +- Added: (new capabilities, scripts, references) +- Modified: (what was changed and why) +- Removed: (what was deprecated/removed and why) + +### Python Scripts + +**New Scripts:** +- `script_name.py` - Purpose and functionality + +**Modified Scripts:** +- `existing_script.py` - Changes made + +### Documentation + +**Files Updated:** +- README.md - (what sections) +- SKILL.md - (what changed) +- Reference files - (which ones) + +--- + +## Testing + +### Testing Performed + +- [ ] Tested with Claude AI (uploaded SKILL.md and verified activation) +- [ ] Tested with Claude Code (loaded skill and ran workflows) +- [ ] All Python scripts run without errors +- [ ] Ran scripts with `--help` flag +- [ ] Tested JSON output (if applicable) +- [ ] All reference links work +- [ ] No broken relative paths + +### Test Results + +**Claude Activation:** +- [ ] Skill activates when appropriate +- [ ] Description triggers correctly +- [ ] Keywords help discovery + +**Python Scripts:** +```bash +# Commands run for testing +python scripts/tool.py --help +python scripts/tool.py test-input.txt +``` + +**Results:** +``` +[Paste test output or describe results] +``` + +--- + +## Quality Checklist + +### SKILL.md Quality + +- [ ] YAML frontmatter is valid +- [ ] `name` matches directory name +- [ ] `description` includes what, when, and keyword triggers +- [ ] `license: MIT` included +- [ ] `metadata` section complete (version, author, category, domain) +- [ ] Keywords section added +- [ ] SKILL.md length <200 lines (or justified if longer) +- [ ] Clear quick start section +- [ ] Core workflows documented +- [ ] Examples included + +### Python Scripts Quality (if applicable) + +- [ ] Production-ready code (not placeholders) +- [ ] CLI with `--help` support +- [ ] Proper error handling +- [ ] Clear docstrings +- [ ] Type hints used +- [ ] Standard library preferred +- [ ] Dependencies documented +- [ ] No hardcoded paths or credentials + +### Documentation Quality + +- [ ] All links work (no 404s) +- [ ] Markdown formatting correct +- [ ] No typos or grammar errors +- [ ] Code blocks have language specified +- [ ] Examples are realistic and complete +- [ ] Screenshots included where helpful + +### Repository Integration + +- [ ] Domain-specific README.md updated (if new skill) +- [ ] Main README.md updated (if new domain or major feature) +- [ ] CLAUDE.md updated (if changes affect development) +- [ ] CHANGELOG.md updated (in Unreleased section) + +--- + +## ROI & Value + +**Estimated Value of This Contribution:** + +**Time Savings:** +- Hours saved per month per user: (estimate) +- Number of potential users: (estimate) + +**Quality Improvements:** +- Specific quality gains: (describe) +- Measurable improvements: (quantify if possible) + +**Why This Matters:** +Brief explanation of the business/user value. + +--- + +## Screenshots + +If applicable, add screenshots to help explain your changes. + +--- + +## Additional Notes + +Any other information reviewers should know: +- Implementation decisions made +- Alternative approaches considered +- Known limitations +- Future enhancement ideas + +--- + +## Contributor Checklist + +**Before Submitting:** +- [ ] I have read [CONTRIBUTING.md](../CONTRIBUTING.md) +- [ ] I have followed the skill creation guidelines +- [ ] I have tested thoroughly +- [ ] I have updated all relevant documentation +- [ ] I have added my changes to CHANGELOG.md (Unreleased section) +- [ ] My code follows the repository's style guidelines +- [ ] All new Python scripts are production-ready +- [ ] I agree to the MIT License for my contributions + +--- + +**Thank you for contributing to Claude Skills Library!** 🚀 + +Your contribution helps make world-class expertise accessible to everyone through Claude AI. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..3196aca --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,197 @@ +# Changelog + +All notable changes to the Claude Skills Library will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Planned +- Complete Anthropic best practices refactoring (37/42 skills remaining) +- Develop production Python tools for RA/QM skills (11 scripts) +- Add medium-content-pro to official documentation +- Marketing expansion: SEO Optimizer, Social Media Manager skills + +--- + +## [1.0.0] - 2025-10-21 + +### Added - Complete Initial Release + +**42 Production-Ready Skills across 6 Domains:** + +#### Marketing Skills (3) +- `content-creator` - Brand voice analyzer, SEO optimizer, content frameworks +- `marketing-demand-acquisition` - Demand gen, paid media, CAC calculator +- `marketing-strategy-pmm` - Positioning, GTM, competitive intelligence + +#### C-Level Advisory (2) +- `ceo-advisor` - Strategy analyzer, financial scenario modeling, board governance +- `cto-advisor` - Tech debt analyzer, team scaling calculator, engineering metrics + +#### Product Team (5) +- `product-manager-toolkit` - RICE prioritizer, interview analyzer, PRD templates +- `agile-product-owner` - User story generator, sprint planning +- `product-strategist` - OKR cascade generator, strategic planning +- `ux-researcher-designer` - Persona generator, user research +- `ui-design-system` - Design token generator, component architecture + +#### Project Management (6) +- `senior-pm` - Portfolio management, stakeholder alignment +- `scrum-master` - Sprint ceremonies, agile coaching +- `jira-expert` - JQL mastery, configuration, dashboards +- `confluence-expert` - Knowledge management, documentation +- `atlassian-admin` - System administration, security +- `atlassian-templates` - Template design, 15+ ready templates + +#### Engineering - Core (9) +- `senior-architect` - Architecture diagrams, dependency analysis, ADRs +- `senior-frontend` - React components, bundle optimization +- `senior-backend` - API scaffolder, database migrations, load testing +- `senior-fullstack` - Project scaffolder, code quality analyzer +- `senior-qa` - Test suite generator, coverage analyzer, E2E tests +- `senior-devops` - CI/CD pipelines, Terraform, deployment automation +- `senior-secops` - Security scanner, vulnerability assessment, compliance +- `code-reviewer` - PR analyzer, code quality checker +- `senior-security` - Threat modeling, security audits, pentesting + +#### Engineering - AI/ML/Data (5) +- `senior-data-scientist` - Experiment designer, feature engineering, statistical analysis +- `senior-data-engineer` - Pipeline orchestrator, data quality validator, ETL +- `senior-ml-engineer` - Model deployment, MLOps setup, RAG system builder +- `senior-prompt-engineer` - Prompt optimizer, RAG evaluator, agent orchestrator +- `senior-computer-vision` - Vision model trainer, inference optimizer, video processor + +#### Regulatory Affairs & Quality Management (12) +- `regulatory-affairs-head` - Regulatory pathway analyzer, submission tracking +- `quality-manager-qmr` - QMS effectiveness monitor, compliance dashboards +- `quality-manager-qms-iso13485` - QMS compliance checker, design control tracker +- `capa-officer` - CAPA tracker, root cause analyzer, trend analysis +- `quality-documentation-manager` - Document version control, technical file builder +- `risk-management-specialist` - Risk register manager, FMEA calculator +- `information-security-manager-iso27001` - ISMS compliance, security risk assessment +- `mdr-745-specialist` - MDR compliance checker, UDI generator +- `fda-consultant-specialist` - FDA submission packager, QSR compliance +- `qms-audit-expert` - Audit planner, finding tracker +- `isms-audit-expert` - ISMS audit planner, security controls assessor +- `gdpr-dsgvo-expert` - GDPR compliance checker, DPIA generator + +### Documentation +- Comprehensive README.md with all 42 skills +- Domain-specific README files (6 domains) +- CLAUDE.md development guide +- Installation and usage guides +- Real-world scenario walkthroughs + +### Automation +- 97 Python CLI tools (20+ verified production-ready) +- 90+ comprehensive reference guides +- Atlassian MCP Server integration + +### ROI Impact +- $20.8M annual value per organization +- 1,720 hours/month time savings +- 70%+ productivity improvements + +--- + +## [1.0.1] - 2025-10-21 + +### Added +- GitHub Star History chart to README.md +- Professional repository presentation + +### Changed +- README.md table of contents anchor links fixed +- Project management folder reorganized (packaged-skills/ structure) + +--- + +## [1.1.0] - 2025-10-21 - Anthropic Best Practices Refactoring + +### Changed - Marketing & C-Level Skills (Phase 1 of 4) + +**Enhanced with Anthropic Agent Skills Specification:** + +**Marketing Skills (3 skills):** +- Added professional metadata (license, version, category, domain) +- Added keywords sections for better discovery +- Enhanced descriptions with explicit triggers +- Added python-tools and tech-stack documentation + +**C-Level Skills (2 skills):** +- Added professional metadata with frameworks +- Added keywords sections (20+ keywords per skill) +- Enhanced descriptions for better Claude activation +- Added technical and strategic terminology + +### Added +- `documentation/implementation/SKILLS_REFACTORING_PLAN.md` - Complete 4-phase refactoring roadmap +- `documentation/PYTHON_TOOLS_AUDIT.md` - Comprehensive tools quality assessment + +**Refactoring Progress:** 5/42 skills complete (12%) + +--- + +## [1.0.2] - 2025-10-21 + +### Added +- `LICENSE` file - Official MIT License +- `CONTRIBUTING.md` - Contribution guidelines and standards +- `CODE_OF_CONDUCT.md` - Community standards (Contributor Covenant 2.0) +- `SECURITY.md` - Security policy and vulnerability reporting +- `CHANGELOG.md` - This file, version history tracking + +### Documentation +- Complete GitHub repository setup for open source +- Professional community health files +- Clear contribution process +- Security vulnerability handling + +--- + +## Version History Summary + +| Version | Date | Key Changes | +|---------|------|-------------| +| 1.1.0 | 2025-10-21 | Anthropic best practices refactoring (5 skills) | +| 1.0.2 | 2025-10-21 | GitHub repository pages (LICENSE, CONTRIBUTING, etc.) | +| 1.0.1 | 2025-10-21 | Star History, link fixes | +| 1.0.0 | 2025-10-21 | Initial release - 42 skills, 6 domains | + +--- + +## Upcoming Releases + +### v1.2.0 (Planned) +- Complete Anthropic refactoring (remaining 37 skills) +- SKILL.md optimization (reduce to <200 lines) +- Progressive disclosure implementation +- allowed-tools restrictions where appropriate + +### v2.0.0 (Planned - Q1 2026) +- Production Python tools for RA/QM skills (11 scripts) +- Marketing expansion (SEO Optimizer, Social Media Manager) +- Business & Growth skills (Sales Engineer, Customer Success) +- Mobile and specialized engineering skills + +--- + +## Notes + +**Semantic Versioning:** +- **Major (x.0.0):** Breaking changes, major new domains +- **Minor (1.x.0):** New skills, significant enhancements +- **Patch (1.0.x):** Bug fixes, documentation updates, minor improvements + +**Contributors:** +All contributors will be credited in release notes for their specific contributions. + +--- + +[Unreleased]: https://github.com/alirezarezvani/claude-skills/compare/v1.0.2...HEAD +[1.1.0]: https://github.com/alirezarezvani/claude-skills/compare/v1.0.1...v1.1.0 +[1.0.2]: https://github.com/alirezarezvani/claude-skills/compare/v1.0.1...v1.0.2 +[1.0.1]: https://github.com/alirezarezvani/claude-skills/compare/v1.0.0...v1.0.1 +[1.0.0]: https://github.com/alirezarezvani/claude-skills/releases/tag/v1.0.0 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..5e69484 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,131 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at: + +**Email:** Available through [alirezarezvani.com](https://alirezarezvani.com) +**Website:** [alirezarezvani.com](https://alirezarezvani.com) + +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4b158bd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,408 @@ +# Contributing to Claude Skills Library + +Thank you for your interest in contributing to the Claude Skills Library! This repository aims to democratize professional expertise through reusable, production-ready skill packages for Claude AI. + +## 🎯 Ways to Contribute + +### 1. Create New Skills + +Add domain expertise in your field: +- Marketing, sales, customer success +- Engineering specializations +- Business functions (finance, HR, operations) +- Industry-specific skills (FinTech, EdTech, etc.) + +### 2. Enhance Existing Skills + +Improve current skills with: +- Better frameworks and templates +- Additional Python automation tools +- Updated best practices +- More reference materials +- Real-world examples and case studies + +### 3. Improve Documentation + +Help others use skills effectively: +- Clearer how-to guides +- Additional usage examples +- Better README files +- Translations to other languages + +### 4. Fix Bugs + +Report or fix issues in: +- Python scripts +- Documentation errors +- Broken links +- Outdated information + +--- + +## 🚀 Getting Started + +### Prerequisites + +- Python 3.7+ (for running/testing scripts) +- Git and GitHub account +- Claude AI or Claude Code account (for testing skills) +- Familiarity with the skill domain you're contributing to + +### Fork and Clone + +```bash +# Fork the repository on GitHub first +git clone https://github.com/YOUR_USERNAME/claude-skills.git +cd claude-skills + +# Add upstream remote +git remote add upstream https://github.com/alirezarezvani/claude-skills.git +``` + +### Create a Branch + +```bash +# Create feature branch +git checkout -b feature/my-new-skill + +# Or for improvements +git checkout -b improvement/enhance-content-creator +``` + +--- + +## 📝 Skill Creation Guidelines + +### Following Anthropic's Official Spec + +All skills must follow [Anthropic's Agent Skills Specification](https://docs.anthropic.com/en/docs/agents-and-tools/agent-skills/overview). + +### Required Structure + +``` +your-skill-name/ +├── SKILL.md (required) +│ ├── YAML frontmatter (name, description, license, metadata) +│ └── Markdown content (instructions, examples, workflows) +├── scripts/ (optional but recommended) +│ ├── tool1.py +│ ├── tool2.py +│ └── tool3.py +├── references/ (optional but recommended) +│ ├── framework.md +│ ├── best-practices.md +│ └── examples.md +└── assets/ (optional) + └── templates/ +``` + +### SKILL.md Requirements + +**YAML Frontmatter (required):** +```yaml +--- +name: your-skill-name +description: What it does and when to use it. Include specific triggers and keywords. +license: MIT +metadata: + version: 1.0.0 + author: Your Name + category: domain-category + updated: 2025-10-28 +--- +``` + +**Markdown Content (required):** +- Clear heading and overview +- Keywords section for discovery +- Quick start guide +- Core workflows +- Script documentation (if applicable) +- Reference guide (if applicable) +- Best practices +- Examples + +**Target Length:** 100-200 lines for SKILL.md +- Keep core instructions lean +- Move detailed content to references/ +- Follow progressive disclosure principle + +### Python Script Standards + +**Quality Requirements:** +- Production-ready code (not placeholders) +- Standard library preferred (minimal dependencies) +- CLI-first design with --help support +- JSON output option for automation +- Clear docstrings and comments +- Error handling and validation + +**Example:** +```python +#!/usr/bin/env python3 +""" +Tool Name - Brief description + +Usage: + python tool.py input.txt [--output json] +""" + +def main(): + # Implementation + pass + +if __name__ == "__main__": + main() +``` + +### Documentation Standards + +- Clear, actionable guidance +- Real-world examples +- Specific metrics and benchmarks +- No generic advice +- Professional tone +- Proper formatting + +--- + +## 🔄 Contribution Process + +### Step 1: Discuss First (Recommended) + +For major contributions: +1. Open an issue describing your idea +2. Discuss approach with maintainers +3. Get feedback before investing time +4. Avoid duplicate efforts + +### Step 2: Develop Your Contribution + +Follow the guidelines above for: +- New skills +- Python tools +- Documentation +- Bug fixes + +### Step 3: Test Thoroughly + +**For New Skills:** +- [ ] YAML frontmatter valid (no syntax errors) +- [ ] Description triggers Claude correctly +- [ ] All Python scripts work with --help +- [ ] All reference links work +- [ ] Skill activates when expected +- [ ] Tested with Claude AI or Claude Code + +**For Python Tools:** +- [ ] Runs without errors +- [ ] Handles edge cases +- [ ] Provides helpful error messages +- [ ] JSON output works (if applicable) +- [ ] Dependencies documented + +### Step 4: Submit Pull Request + +```bash +# Commit your changes +git add . +git commit -m "feat(domain): add new-skill with [capabilities]" + +# Push to your fork +git push origin feature/my-new-skill + +# Create pull request on GitHub +``` + +**PR Title Format:** +- `feat(domain): add new skill for [purpose]` +- `fix(skill-name): correct issue with [component]` +- `docs(domain): improve documentation for [topic]` +- `refactor(skill-name): optimize [component]` + +**PR Description Must Include:** +- What: What does this add/change/fix? +- Why: Why is this valuable? +- Testing: How was it tested? +- Documentation: What docs were updated? + +--- + +## ✅ Quality Standards + +### Skill Quality Checklist + +All new skills must meet these standards: + +**Documentation:** +- [ ] Clear SKILL.md with all required sections +- [ ] Enhanced description with triggers and keywords +- [ ] Keywords section for discovery +- [ ] Quick start guide with 2-3 examples +- [ ] Professional metadata (license, version, author) +- [ ] Domain-specific README updated (if applicable) + +**Python Tools (if included):** +- [ ] Production-ready code (not placeholders) +- [ ] CLI with --help support +- [ ] Proper error handling +- [ ] Clear docstrings +- [ ] Dependencies minimal and documented + +**References (if included):** +- [ ] Actionable frameworks and templates +- [ ] Specific guidance (not generic advice) +- [ ] Real-world benchmarks and examples +- [ ] Properly linked from SKILL.md + +**Testing:** +- [ ] Skill activates correctly with Claude +- [ ] All scripts execute without errors +- [ ] All links work +- [ ] No broken references + +**ROI:** +- [ ] Demonstrates measurable value +- [ ] Time savings quantified +- [ ] Quality improvements specified +- [ ] Clear use cases documented + +--- + +## 🎨 Style Guide + +### Python Code + +**Follow PEP 8:** +- 4 spaces for indentation +- Max line length: 100 characters +- Clear variable names +- Docstrings for functions + +**Example:** +```python +def analyze_content(text: str, keywords: list) -> dict: + """ + Analyze text content for keyword density and readability. + + Args: + text: Content to analyze + keywords: List of keywords to check + + Returns: + dict: Analysis results with scores and recommendations + """ + pass +``` + +### Markdown Documentation + +- Use headers consistently (H1 for title, H2 for sections) +- Include code blocks with language specification +- Use tables for comparisons +- Add emojis sparingly for visual hierarchy +- Keep paragraphs concise + +### Commit Messages + +Follow [Conventional Commits](https://www.conventionalcommits.org/): + +- `feat(domain): add new capability` +- `fix(skill): correct bug in script` +- `docs(readme): update installation guide` +- `refactor(skill): optimize SKILL.md length` +- `test(tool): add test coverage` + +--- + +## 🏆 Recognition + +### Contributors + +All contributors will be: +- Listed in CHANGELOG.md for their contributions +- Mentioned in release notes +- Credited in PR merge messages +- Acknowledged in the community + +### Significant Contributions + +Major contributions may result in: +- Co-author credit in commits +- Feature attribution in documentation +- Highlighted in README +- Social media recognition + +--- + +## 📋 Domain-Specific Guidelines + +### Marketing Skills + +- Include real benchmarks (CAC, conversion rates, etc.) +- Platform-specific guidance (LinkedIn, Google, etc.) +- B2B or B2C focus clearly stated +- International market considerations + +### Engineering Skills + +- Include tech stack in metadata +- Provide architecture patterns +- Add code quality standards +- Performance benchmarks + +### Product Skills + +- Include frameworks (RICE, OKR, etc.) +- Real-world metrics and KPIs +- Template-heavy with examples +- Integration points with tools + +### Regulatory/Quality Skills + +- Cite specific standards (ISO, FDA, EU MDR) +- Compliance frameworks clear +- Industry-specific (HealthTech, MedTech) +- Regulatory jurisdiction specified + +--- + +## 🚫 What NOT to Contribute + +**We will not accept:** +- Generic advice without actionable frameworks +- Placeholder scripts (must be production-ready) +- Skills without clear use cases +- Duplicate capabilities of existing skills +- Proprietary or confidential information +- Content that violates licenses +- Skills promoting unethical practices + +--- + +## 🤝 Code of Conduct + +By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). + +Expected behavior: +- Be respectful and inclusive +- Provide constructive feedback +- Focus on what's best for the community +- Show empathy and kindness + +--- + +## 📞 Questions? + +- **General Questions:** Open a [discussion](https://github.com/alirezarezvani/claude-skills/discussions) +- **Bug Reports:** Use [bug report template](https://github.com/alirezarezvani/claude-skills/issues/new?template=bug_report.md) +- **Feature Ideas:** Use [feature request template](https://github.com/alirezarezvani/claude-skills/issues/new?template=feature_request.md) +- **Contact:** [alirezarezvani.com](https://alirezarezvani.com) or [medium.com/@alirezarezvani](https://medium.com/@alirezarezvani) + +--- + +## 🙏 Thank You! + +Your contributions help make world-class expertise accessible to everyone through Claude AI. Every skill added, bug fixed, or documentation improved makes a difference. + +**Happy contributing!** 🚀 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c3e30bc --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Alireza Rezvani + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..f42caf4 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,294 @@ +# Security Policy + +## Supported Versions + +We release updates and security fixes for the following versions: + +| Version | Supported | +| ------- | ------------------ | +| 1.x.x | :white_check_mark: | +| < 1.0 | :x: | + +All skills are currently at version 1.0.0 and receive active support. + +## Reporting a Vulnerability + +We take security seriously. If you discover a security vulnerability within this repository, please follow these steps: + +### 1. Do NOT Open a Public Issue + +Please **do not** create a public GitHub issue for security vulnerabilities. This helps protect users while we work on a fix. + +### 2. Contact Us Privately + +Report security vulnerabilities through: + +**Primary Contact:** +- **Website:** [alirezarezvani.com](https://alirezarezvani.com) (use contact form) +- **Medium:** [@alirezarezvani](https://medium.com/@alirezarezvani) (private message) + +**Information to Include:** +- Type of vulnerability +- Full details of the vulnerability +- Steps to reproduce +- Potential impact +- Suggested fix (if you have one) +- Your contact information + +### 3. Response Timeline + +We aim to respond to security reports according to this timeline: + +- **Initial Response:** Within 48 hours +- **Vulnerability Assessment:** Within 1 week +- **Fix Development:** Based on severity (see below) +- **Public Disclosure:** After fix is deployed + +### Severity Levels + +**Critical (24-48 hours):** +- Remote code execution +- Unauthorized access to sensitive data +- Privilege escalation + +**High (1 week):** +- Data exposure +- Authentication bypass +- Significant security weakness + +**Medium (2 weeks):** +- Cross-site scripting (XSS) +- Information disclosure +- Security misconfigurations + +**Low (1 month):** +- Minor information leaks +- Best practice violations +- Non-critical security improvements + +--- + +## Security Best Practices for Users + +### When Using Skills + +**1. Review Python Scripts Before Execution** + +Always review what a script does before running it: +```bash +# Read the script first +cat scripts/tool.py + +# Check for: +# - External network calls +# - File system modifications +# - Environment variable access +# - Suspicious imports +``` + +**2. Run Scripts in Sandboxed Environments** + +For untrusted or new scripts: +```bash +# Use virtual environments +python -m venv venv +source venv/bin/activate +pip install -r requirements.txt + +# Or use Docker +docker run -it --rm -v $(pwd):/work python:3.11 python /work/scripts/tool.py +``` + +**3. Verify SKILL.md Content** + +Check that SKILL.md: +- Doesn't request sensitive information +- Has clear, documented workflows +- Follows Anthropic's spec +- Has valid YAML frontmatter + +**4. Use allowed-tools Restrictions** + +If a skill has `allowed-tools` in frontmatter, it's restricted to those tools only: +```yaml +--- +allowed-tools: Read, Grep, Glob +--- +``` +This provides an additional safety layer. + +--- + +## Security in Skill Development + +### Secure Coding Practices + +**For Python Scripts:** + +**DO:** +- ✅ Validate all inputs +- ✅ Use parameterized queries (if using databases) +- ✅ Handle errors gracefully +- ✅ Limit file system access to necessary directories +- ✅ Use type hints for safety +- ✅ Sanitize user input + +**DON'T:** +- ❌ Use eval() or exec() with user input +- ❌ Execute shell commands with unsanitized input +- ❌ Store credentials in code +- ❌ Make unchecked network requests +- ❌ Access sensitive system files +- ❌ Use deprecated libraries with known vulnerabilities + +**Example - Secure Input Handling:** +```python +import os +import re + +def safe_read_file(filename: str) -> str: + """Safely read a file with validation.""" + # Validate filename + if not re.match(r'^[a-zA-Z0-9._-]+$', filename): + raise ValueError("Invalid filename") + + # Prevent directory traversal + if '..' in filename or filename.startswith('/'): + raise ValueError("Invalid file path") + + # Read from safe directory + safe_dir = os.path.join(os.getcwd(), 'data') + full_path = os.path.join(safe_dir, filename) + + # Verify path is within safe directory + if not full_path.startswith(safe_dir): + raise ValueError("Path outside safe directory") + + with open(full_path, 'r') as f: + return f.read() +``` + +### Dependency Management + +**Keep Dependencies Minimal:** +- Prefer Python standard library +- Document all external dependencies +- Pin dependency versions +- Regularly update for security patches + +**Check Dependencies:** +```bash +# Audit Python dependencies +pip install safety +safety check + +# Or use pip-audit +pip install pip-audit +pip-audit +``` + +--- + +## Vulnerability Disclosure Process + +### For Maintainers + +When a vulnerability is reported: + +1. **Acknowledge Receipt** (48 hours) + - Confirm we received the report + - Provide expected timeline + +2. **Assess Severity** (1 week) + - Evaluate impact and scope + - Determine priority level + - Assign severity rating + +3. **Develop Fix** (Based on severity) + - Create patch in private branch + - Test thoroughly + - Prepare security advisory + +4. **Deploy Fix** + - Merge to main + - Tag new version + - Publish GitHub security advisory + +5. **Public Disclosure** + - Announce in CHANGELOG + - Credit reporter (if desired) + - Provide mitigation guidance + +--- + +## Security Features + +### Current Security Measures + +**Repository:** +- All skills open source (transparent review) +- MIT License (clear usage terms) +- No secrets or credentials committed +- Clean .gitignore for sensitive files + +**Python Scripts:** +- Standard library preferred (minimal attack surface) +- No network calls in core tools +- File system access limited +- Input validation implemented + +**Documentation:** +- Clear usage instructions +- Security considerations documented +- Best practices included +- Safe examples provided + +### Planned Security Enhancements + +**v1.1.0:** +- Automated dependency scanning +- GitHub Dependabot integration +- Security advisories enabled +- Vulnerability scanning in CI/CD + +--- + +## Responsible Disclosure + +We appreciate security researchers who: +- Report vulnerabilities responsibly +- Give us time to fix before public disclosure +- Provide detailed reproduction steps +- Suggest potential fixes + +### Recognition + +Security researchers who responsibly disclose will be: +- Credited in CHANGELOG (if desired) +- Mentioned in security advisory +- Recognized in README (optional) +- Thanked publicly on social media (with permission) + +--- + +## Contact + +For security-related inquiries: + +- **Website:** [alirezarezvani.com](https://alirezarezvani.com) +- **Blog:** [medium.com/@alirezarezvani](https://medium.com/@alirezarezvani) +- **GitHub Issues:** For non-security bugs only + +**Please do not use public channels for security vulnerabilities.** + +--- + +## Additional Resources + +- [OWASP Top 10](https://owasp.org/www-project-top-ten/) +- [Python Security Best Practices](https://python.readthedocs.io/en/stable/library/security_warnings.html) +- [GitHub Security Advisories](https://docs.github.com/en/code-security/security-advisories) + +--- + +Thank you for helping keep the Claude Skills Library and its users safe!