Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
145 lines (109 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

145 lines (109 loc) · 2.97 KB
Raw

Contributing to MCP Tutorial

First off, thank you for considering contributing to the Model Context Protocol (MCP) Tutorial! This is a community-driven project that helps developers learn and implement AI tool integrations effectively.

Why Contribute?

  • 🎓 Help others learn AI development
  • 💡 Share your expertise in MCP implementation
  • 🚀 Improve the quality of AI tool development
  • 👥 Join a community of AI developers
  • ⭐ Get recognition for your contributions

Ways to Contribute

  1. Improve Documentation

    • Fix typos and grammar
    • Add code comments
    • Improve explanations
    • Add examples

  2. Add New Content

    • Create new tutorials
    • Add practical examples
    • Share best practices
    • Write case studies

  3. Code Contributions

    • Fix bugs
    • Add features
    • Improve performance
    • Write tests

  4. Review & Feedback

    • Review pull requests
    • Test implementations
    • Provide feedback
    • Report issues

Getting Started

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/your-username/mcp-tutorial.git
cd mcp-tutorial
  3. Create a virtual environment: 
    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  4. Install dependencies: 
    pip install -r requirements.txt

Development Workflow

  1. Create a new branch:

    git checkout -b feature/your-feature-name

  2. Make your changes

  3. Test your changes:

    pytest
pytest --nbval notebooks/  # Test notebooks

  4. Commit your changes:

    git add .
git commit -m "feat: add your feature description"

  5. Push to your fork:

    git push origin feature/your-feature-name

  6. Create a Pull Request

Commit Message Guidelines

We follow the Conventional Commits specification:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code style changes
  • refactor: Code refactoring
  • test: Adding or updating tests
  • chore: Maintenance tasks

Code Style

  • Follow PEP 8 guidelines
  • Use type hints
  • Write descriptive docstrings
  • Add comments for complex logic
  • Keep functions focused and small

Documentation

  • Use clear and concise language
  • Include code examples
  • Add docstrings to functions
  • Update README when needed
  • Keep tutorials up to date

Community

  • Be respectful and inclusive
  • Help others learn
  • Share knowledge
  • Provide constructive feedback
  • Follow our Code of Conduct

Questions?

Feel free to:

  • Open an issue
  • Start a discussion
  • Join our community chat

Recognition

Contributors will be:

  • Listed in our README
  • Mentioned in release notes
  • Featured in our documentation

Thank you for contributing to better AI tool development! 🚀

Happy Contributing! ❤️

Back to README • Code of Conduct • License