# Contributing to Claude Skills Thank you for your interest in contributing to the Claude Skills repository! ## Getting Started 1. Fork the repository 2. Create a feature branch (`git checkout -b feature/skill-name`) 3. Make your changes 4. Test thoroughly 5. Create a pull request ## Skill Development Guidelines ### Structure Each skill should follow this format: ```markdown --- name: skill-name title: Human-Readable Title version: 1.0.0 author: Your Name category: category-name keywords: [keyword1, keyword2, ...] description: Clear description of what the skill does icon: ✓ activation_phrases: - "@skill-name" - "phrase one" - "phrase two" min_claude_version: 3.5 compatibility: - Language1 - Language2 --- # Skill Name [Detailed documentation...] ``` ### Required Sections - **Name**: Unique identifier (kebab-case) - **Title**: Human-readable name - **Description**: Clear, concise description - **Activation Phrases**: At least 3-5 common ways to invoke - **Purpose**: Why someone would use this skill - **Usage**: How to use it - **Features**: What it does - **Examples**: Real-world examples - **Requirements**: What's needed to use it ### Optional Sections - **Compatibility**: Languages, frameworks, platforms - **Performance**: Time estimates, resource usage - **Limitations**: What it can't do - **Troubleshooting**: Common issues - **Roadmap**: Planned improvements ## Quality Standards ### Documentation - [ ] Clear purpose and use cases - [ ] Real-world examples included - [ ] Prerequisites documented - [ ] Output format explained - [ ] Limitations noted ### Functionality - [ ] Works language-agnostic (or clearly documents limitations) - [ ] Handles errors gracefully - [ ] Provides helpful feedback - [ ] Safe operations (no destructive changes without confirmation) - [ ] Security best practices followed ### Format - [ ] Valid YAML frontmatter - [ ] Proper markdown formatting - [ ] No spelling errors - [ ] Links work correctly - [ ] Code examples are accurate ## Categories Skills should be categorized as: - **code-review**: Code quality and review automation - **security**: Security analysis and validation - **architecture**: Architecture and design patterns - **testing**: Testing and test coverage - **documentation**: Documentation generation and management - **refactoring**: Code refactoring assistance - **performance**: Performance optimization - **devops**: DevOps and deployment - **utilities**: General utilities ## Naming Conventions - Skill names: `kebab-case` (e.g., `master-workflow`) - Titles: Title Case with clear description - Activation phrases: Natural language phrases users would say - File names: `skill-name.md` ## Testing Before submitting: 1. **Syntax Check** - Valid YAML frontmatter - Proper markdown syntax - No broken links 2. **Functionality Test** - Invoke the skill multiple ways - Test with different project types - Verify all features work - Test error cases 3. **Documentation Review** - Clear and complete - Examples work - Requirements documented - Limitations noted ## Pull Request Process 1. Create a descriptive PR title 2. Include a summary of changes 3. Reference any related issues 4. Ensure all checks pass 5. Request review from maintainers ### PR Template ```markdown ## Description [Brief description of the skill] ## Type of Change - [ ] New skill - [ ] Enhancement to existing skill - [ ] Bug fix - [ ] Documentation update ## Checklist - [ ] Documentation is clear and complete - [ ] Examples are included and tested - [ ] YAML frontmatter is valid - [ ] Markdown formatting is correct - [ ] No spelling errors - [ ] Code examples are accurate ## Testing [Describe how you tested the skill] ## Additional Notes [Any additional context] ``` ## Skill Ideas We're always looking for new skills in these areas: - **Code Analysis**: Static analysis, complexity detection, pattern matching - **Security**: Vulnerability scanning, OWASP validation, secrets detection - **Documentation**: Auto-documentation, changelog generation, API docs - **Testing**: Test generation, coverage analysis, test best practices - **DevOps**: Deployment validation, infrastructure review, CI/CD checks - **Refactoring**: Automated refactoring suggestions, code improvements - **Performance**: Performance optimization, bottleneck detection - **Git**: Git workflow automation, commit message validation ## Code of Conduct - Be respectful and inclusive - Provide constructive feedback - Ask questions when unclear - Help others learn and grow - Focus on the problem, not the person ## Questions? - Check existing issues for answers - Create a new issue if needed - Join discussions in pull requests - Be patient and respectful ## Recognition Contributors will be: - Listed in the repository - Credited in changelog - Acknowledged in documentation - Featured on the marketplace ## License By contributing, you agree that your contributions will be licensed under the same license as the project (see LICENSE file). --- Thank you for contributing to Claude Skills!