Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
108 lines (81 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

108 lines (81 loc) · 3.76 KB

Contributing to Codex Agentic Patterns

Thank you for your interest in contributing! This is an educational resource focused on teaching agentic AI patterns through production-grade examples.

🎯 How to Contribute

📝 Documentation Improvements

  • Fix typos, grammar, or unclear explanations
  • Add more detailed examples or use cases
  • Improve code comments and docstrings
  • Enhance README files and learning guides

💻 Code Contributions

  • Fix bugs in Python examples
  • Add error handling or edge cases
  • Improve code efficiency or readability
  • Add new pattern implementations (with approval)

🎓 Educational Enhancements

  • Create new exercises or challenges
  • Add learning assessments
  • Improve learning path organization
  • Suggest better analogies or explanations

📋 Contribution Guidelines

Before You Start

  1. Check existing issues - Someone might already be working on it
  2. Open a discussion - For major changes, discuss first
  3. Follow the style - Match existing code and documentation style

Code Standards

  • Python: Follow PEP 8, use type hints where helpful
  • Documentation: Clear, beginner-friendly explanations
  • Examples: Must be runnable and well-commented
  • Attribution: Cite sources for any external patterns

Documentation Standards

  • Clarity First: Educational value over brevity
  • Consistent Format: Follow existing structure
  • Real Examples: Prefer production patterns over toy examples
  • Progressive Complexity: Build from simple to advanced

🚀 Getting Started

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Test thoroughly: Ensure examples run correctly
  5. Commit with clear messages: Describe what and why
  6. Push and create a Pull Request

📖 Types of Contributions Needed

High Priority

  • 🐛 Bug fixes in existing code examples
  • 📚 Documentation improvements for clarity
  • 🎯 Exercise solutions and explanations
  • 🔧 Setup improvements for different environments

Medium Priority

  • 🆕 New pattern implementations (discuss first)
  • 🎨 Visual diagrams for complex patterns
  • 🧪 Test cases for code examples
  • 📊 Performance improvements

Low Priority

  • 🌐 Translations to other languages
  • 🎥 Video tutorials or walkthroughs
  • 📱 Mobile-friendly documentation
  • 🎨 Design improvements

❌ What We Don't Accept

  • Toy examples that oversimplify real patterns
  • Unattributed code without proper citations
  • Breaking changes without discussion
  • Non-educational content (pure marketing, etc.)
  • Patterns not grounded in real production systems

🎓 Educational Focus

Remember, this is a learning resource. All contributions should:

  • ✅ Teach effectively - Clear explanations for learners
  • ✅ Build progressively - Simple to complex
  • ✅ Stay practical - Real-world applicable
  • ✅ Maintain quality - Production-grade examples
  • ✅ Cite sources - Especially for Codex patterns

📞 Questions?

  • Open an issue for bugs or feature requests
  • Start a discussion for questions or ideas
  • Check existing docs first - answer might be there

🙏 Recognition

All contributors will be:

  • Listed in the repository contributors
  • Mentioned in release notes for significant contributions
  • Credited in documentation they improve

Thank you for helping make agentic AI patterns accessible to developers worldwide! 🚀

This project builds upon the Agentic Design Patterns textbook and OpenAI's Codex CLI.