Skip to content

Latest commit

 

History

History
353 lines (258 loc) · 9.93 KB

File metadata and controls

353 lines (258 loc) · 9.93 KB

🤝 Contributing to The Agency

First off, thank you for considering contributing to The Agency! It's people like you who make this collection of AI agents better for everyone.

📋 Table of Contents


📜 Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code:

  • Be Respectful: Treat everyone with respect. Healthy debate is encouraged, but personal attacks are not tolerated.
  • Be Inclusive: Welcome and support people of all backgrounds and identities.
  • Be Collaborative: What we create together is better than what we create alone.
  • Be Professional: Keep discussions focused on improving the agents and the community.

🎯 How Can I Contribute?

1. Create a New Agent

Have an idea for a specialized agent? Great! Here's how to add one:

  1. Fork the repository

  2. Choose the appropriate category (or propose a new one):

    • engineering/ - Software development specialists
    • design/ - UX/UI and creative specialists
    • marketing/ - Growth and marketing specialists
    • product/ - Product management specialists
    • project-management/ - PM and coordination specialists
    • testing/ - QA and testing specialists
    • support/ - Operations and support specialists
    • spatial-computing/ - AR/VR/XR specialists
    • specialized/ - Unique specialists that don't fit elsewhere
  3. Create your agent file following the template below

  4. Test your agent in real scenarios

  5. Submit a Pull Request with your agent

2. Improve Existing Agents

Found a way to make an agent better? Contributions welcome:

  • Add real-world examples and use cases
  • Enhance code samples with modern patterns
  • Update workflows based on new best practices
  • Add success metrics and benchmarks
  • Fix typos, improve clarity, enhance documentation

3. Share Success Stories

Used these agents successfully? Share your story:

  • Post in GitHub Discussions
  • Add a case study to the README
  • Write a blog post and link it
  • Create a video tutorial

4. Report Issues

Found a problem? Let us know:

  • Check if the issue already exists
  • Provide clear reproduction steps
  • Include context about your use case
  • Suggest potential solutions if you have ideas

🎨 Agent Design Guidelines

Agent File Structure

Every agent should follow this structure:

---
name: Agent Name
description: One-line description of the agent's specialty and focus
color: colorname or "#hexcode"
---

# Agent Name

## 🧠 Your Identity & Memory
- **Role**: Clear role description
- **Personality**: Personality traits and communication style
- **Memory**: What the agent remembers and learns
- **Experience**: Domain expertise and perspective

## 🎯 Your Core Mission
- Primary responsibility 1 with clear deliverables
- Primary responsibility 2 with clear deliverables
- Primary responsibility 3 with clear deliverables
- **Default requirement**: Always-on best practices

## 🚨 Critical Rules You Must Follow
Domain-specific rules and constraints that define the agent's approach

## 📋 Your Technical Deliverables
Concrete examples of what the agent produces:
- Code samples
- Templates
- Frameworks
- Documents

## 🔄 Your Workflow Process
Step-by-step process the agent follows:
1. Phase 1: Discovery and research
2. Phase 2: Planning and strategy
3. Phase 3: Execution and implementation
4. Phase 4: Review and optimization

## 💭 Your Communication Style
- How the agent communicates
- Example phrases and patterns
- Tone and approach

## 🔄 Learning & Memory
What the agent learns from:
- Successful patterns
- Failed approaches
- User feedback
- Domain evolution

## 🎯 Your Success Metrics
Measurable outcomes:
- Quantitative metrics (with numbers)
- Qualitative indicators
- Performance benchmarks

## 🚀 Advanced Capabilities
Advanced techniques and approaches the agent masters

Agent Design Principles

  1. 🎭 Strong Personality

    • Give the agent a distinct voice and character
    • Not "I am a helpful assistant" - be specific and memorable
    • Example: "I default to finding 3-5 issues and require visual proof" (Evidence Collector)
  2. 📋 Clear Deliverables

    • Provide concrete code examples
    • Include templates and frameworks
    • Show real outputs, not vague descriptions
  3. ✅ Success Metrics

    • Include specific, measurable metrics
    • Example: "Page load times under 3 seconds on 3G"
    • Example: "10,000+ combined karma across accounts"
  4. 🔄 Proven Workflows

    • Step-by-step processes
    • Real-world tested approaches
    • Not theoretical - battle-tested
  5. 💡 Learning Memory

    • What patterns the agent recognizes
    • How it improves over time
    • What it remembers between sessions

What Makes a Great Agent?

Great agents have:

  • ✅ Narrow, deep specialization
  • ✅ Distinct personality and voice
  • ✅ Concrete code/template examples
  • ✅ Measurable success metrics
  • ✅ Step-by-step workflows
  • ✅ Real-world testing and iteration

Avoid:

  • ❌ Generic "helpful assistant" personality
  • ❌ Vague "I will help you with..." descriptions
  • ❌ No code examples or deliverables
  • ❌ Overly broad scope (jack of all trades)
  • ❌ Untested theoretical approaches

🔄 Pull Request Process

Before Submitting

  1. Test Your Agent: Use it in real scenarios, iterate on feedback
  2. Follow the Template: Match the structure of existing agents
  3. Add Examples: Include at least 2-3 code/template examples
  4. Define Metrics: Include specific, measurable success criteria
  5. Proofread: Check for typos, formatting issues, clarity

Submitting Your PR

  1. Fork the repository
  2. Create a branch: git checkout -b add-agent-name
  3. Make your changes: Add your agent file(s)
  4. Commit: git commit -m "Add [Agent Name] specialist"
  5. Push: git push origin add-agent-name
  6. Open a Pull Request with:
    • Clear title: "Add [Agent Name] - [Category]"
    • Description of what the agent does
    • Why this agent is needed (use case)
    • Any testing you've done

PR Review Process

  1. Community Review: Other contributors may provide feedback
  2. Iteration: Address feedback and make improvements
  3. Approval: Maintainers will approve when ready
  4. Merge: Your contribution becomes part of The Agency!

PR Template

## Agent Information
**Agent Name**: [Name]
**Category**: [engineering/design/marketing/etc.]
**Specialty**: [One-line description]

## Motivation
[Why is this agent needed? What gap does it fill?]

## Testing
[How have you tested this agent? Real-world use cases?]

## Checklist
- [ ] Follows agent template structure
- [ ] Includes personality and voice
- [ ] Has concrete code/template examples
- [ ] Defines success metrics
- [ ] Includes step-by-step workflow
- [ ] Proofread and formatted correctly
- [ ] Tested in real scenarios

📐 Style Guide

Writing Style

  • Be specific: "Reduce page load by 60%" not "Make it faster"
  • Be concrete: "Create React components with TypeScript" not "Build UIs"
  • Be memorable: Give agents personality, not generic corporate speak
  • Be practical: Include real code, not pseudo-code

Formatting

  • Use Markdown formatting consistently
  • Include emojis for section headers (makes scanning easier)
  • Use code blocks for all code examples with proper syntax highlighting
  • Use tables for comparing options or showing metrics
  • Use bold for emphasis, code for technical terms

Code Examples

## Example Code Block

\`\`\`typescript
// Always include:
// 1. Language specification for syntax highlighting
// 2. Comments explaining key concepts
// 3. Real, runnable code (not pseudo-code)
// 4. Modern best practices

interface AgentExample {
  name: string;
  specialty: string;
  deliverables: string[];
}
\`\`\`

Tone

  • Professional but approachable: Not overly formal or casual
  • Confident but not arrogant: "Here's the best approach" not "Maybe you could try..."
  • Helpful but not hand-holding: Assume competence, provide depth
  • Personality-driven: Each agent should have a unique voice

🌟 Recognition

Contributors who make significant contributions will be:

  • Listed in the README acknowledgments section
  • Highlighted in release notes
  • Featured in "Agent of the Week" showcases (if applicable)
  • Given credit in the agent file itself

🤔 Questions?


📚 Resources

For New Contributors

For Agent Design

  • Read existing agents for inspiration
  • Study the patterns that work well
  • Test your agents in real scenarios
  • Iterate based on feedback

🎉 Thank You!

Your contributions make The Agency better for everyone. Whether you're:

  • Adding a new agent
  • Improving documentation
  • Fixing bugs
  • Sharing success stories
  • Helping other contributors

You're making a difference. Thank you!


Questions? Ideas? Feedback?

Open an IssueStart a DiscussionSubmit a PR

Made with ❤️ by the community