alihan/awesome-claude-code-subagents
1
0
Fork 0
mirror of https://github.com/VoltAgent/awesome-claude-code-subagents.git synced 2025-10-27 15:44:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md to clarify required updates when adding a new agent

Browse Source
This commit is contained in:
Necati Ozmen
2025-08-06 16:49:14 +03:00
parent 4a9eae417f
commit 861ab815a8
1 changed files with 28 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
CONTRIBUTING.md
View File

@@ -8,7 +8,11 @@ Thank you for your interest in contributing to this collection!
1. **Choose the right category** - Place your subagent in the most appropriate category folder 1. **Choose the right category** - Place your subagent in the most appropriate category folder
2. **Test your subagent** - Ensure it works with Claude Code 2. **Test your subagent** - Ensure it works with Claude Code
3. **Submit a PR** - Include a clear description of the subagent's purpose 3. **Update required files** - When adding a new agent, you must update:
- **Main README.md**: Add your agent to the appropriate category section in alphabetical order
- **Category README.md**: Add detailed description, update Quick Selection Guide table, and if applicable, Common Technology Stacks
- **Your agent .md file**: Create the actual agent definition following the template
4. **Submit a PR** - Include a clear description of the subagent's purpose
### Subagent Requirements ### Subagent Requirements
@@ -21,6 +25,24 @@ Each subagent should include:
- Example usage scenarios - Example usage scenarios
- Best practices - Best practices
### Required Updates When Adding a New Agent
When you add a new agent, you MUST update these files:
1. **Main README.md**
- Add your agent link in the appropriate category section
- Maintain alphabetical order
- Format: `- [**agent-name**](path/to/agent.md) - Brief description`
2. **Category README.md** (e.g., `categories/02-language-specialists/README.md`)
- Add detailed agent description in the "Available Subagents" section
- Update the "Quick Selection Guide" table
- If applicable, add to "Common Technology Stacks" section
3. **Your Agent File** (e.g., `categories/02-language-specialists/your-agent.md`)
- Follow the standard template structure
- Include all required sections
### Code of Conduct ### Code of Conduct
- Be respectful and inclusive - Be respectful and inclusive
@@ -33,8 +55,11 @@ Each subagent should include:
1. Fork the repository 1. Fork the repository
2. Create a feature branch (`git checkout -b feature/new-subagent`) 2. Create a feature branch (`git checkout -b feature/new-subagent`)
3. Add your subagent following the template 3. Add your subagent following the template
4. Update the category README if needed 4. Update ALL required locations:
5. Submit a pull request with a clear description - Main README.md (add to category section in alphabetical order)
- Category-specific README.md (add description, update tables)
5. Verify all links work correctly
6. Submit a pull request with a clear description
### Quality Guidelines ### Quality Guidelines