Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (49 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

70 lines (49 loc) · 2.22 KB

Contributing to MCP SSE Proxy Server

First off, thank you for considering contributing to MCP SSE Proxy Server! It's people like you that make it such a great tool.

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.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include any error messages or logs

Suggesting Enhancements

If you have a suggestion for the project, we'd love to hear it. Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • A clear and descriptive title
  • A detailed description of the proposed enhancement
  • An explanation of why this enhancement would be useful
  • Any potential drawbacks or challenges

Pull Requests

  • Fill in the required template
  • Follow the Python style guide (PEP 8)
  • Include comments in your code where necessary
  • Update the documentation if needed
  • Add tests if applicable
  • Ensure the test suite passes
  • Make sure your code lints

Development Process

  1. Fork the repo
  2. Create a new branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run the tests
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

# Clone your fork
git clone https://github.com/your-username/mcpproxy.git

# Create a virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows use `.venv\Scripts\activate`

# Install dependencies
pip install -r requirements.txt

# Run tests
python -m pytest

License

By contributing, you agree that your contributions will be licensed under the MIT License.