contributing.md

Contributing Guidelines

Thank you for your interest in contributing! 🎉

How to Contribute

Submitting Patterns

1. Ensure the pattern is proven — ideally used in production
2. Include code examples — Python or pseudocode
3. Describe use cases — when to use and when not to use
4. Explain trade-offs — benefits and limitations
5. Submit a pull request

Pattern Format

### Pattern Name

Brief description of what the pattern does.

```python
# Code example
def pattern_implementation():
    pass

Use when: Describe scenarios where this pattern applies Examples: Real-world implementations if available

---

### Categories

- Fundamental Patterns
- Reasoning Patterns
- Memory Patterns
- Tool Use Patterns
- Planning Patterns
- Multi-Agent Patterns
- Orchestration Patterns
- Safety Patterns
- Evaluation Patterns
- Deployment Patterns

### Quality Standards

Patterns should:
- Solve a real problem
- Be implementable
- Include working code or clear pseudocode
- Explain trade-offs
- Have clear use cases

### Code Examples

- Prefer Python for examples
- Include comments explaining key parts
- Keep examples concise but complete
- Test code before submitting

### Attribution

If submitting a pattern from a paper or existing work:
- Cite the original source
- Link to the paper or documentation
- Credit the original authors

## Code of Conduct

- Be respectful and constructive
- Focus on practical, usable patterns
- Help others understand complex concepts

## Questions?

Open an issue if you have questions.

Thank you for contributing! 🚀