From 861ab815a85c80fc788385b2fd0f6d522913e799 Mon Sep 17 00:00:00 2001 From: Necati Ozmen Date: Wed, 6 Aug 2025 16:49:14 +0300 Subject: [PATCH] Update CONTRIBUTING.md to clarify required updates when adding a new agent --- CONTRIBUTING.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 074f015..32bd5d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 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 @@ -21,6 +25,24 @@ Each subagent should include: - Example usage scenarios - 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 - Be respectful and inclusive @@ -33,8 +55,11 @@ Each subagent should include: 1. Fork the repository 2. Create a feature branch (`git checkout -b feature/new-subagent`) 3. Add your subagent following the template -4. Update the category README if needed -5. Submit a pull request with a clear description +4. Update ALL required locations: + - 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