mirror of
https://github.com/aljazceru/mcp-python-sdk.git
synced 2025-12-19 14:54:24 +01:00
57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
# Contributing
|
|
|
|
Thank you for your interest in contributing to the MCP Python SDK! This document provides guidelines and instructions for contributing.
|
|
|
|
## Development Setup
|
|
|
|
1. Make sure you have Python 3.10+ installed
|
|
2. Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
|
|
3. Fork the repository
|
|
4. Clone your fork: `git clone https://github.com/YOUR-USERNAME/python-sdk.git`
|
|
5. Install dependencies:
|
|
```bash
|
|
uv sync --frozen --all-extras --dev
|
|
```
|
|
|
|
## Development Workflow
|
|
|
|
1. Create a new branch for your changes
|
|
2. Make your changes
|
|
3. Ensure tests pass:
|
|
```bash
|
|
uv run pytest
|
|
```
|
|
4. Run type checking:
|
|
```bash
|
|
uv run pyright
|
|
```
|
|
5. Run linting:
|
|
```bash
|
|
uv run ruff check .
|
|
uv run ruff format .
|
|
```
|
|
6. Submit a pull request
|
|
|
|
## Code Style
|
|
|
|
- We use `ruff` for linting and formatting
|
|
- Follow PEP 8 style guidelines
|
|
- Add type hints to all functions
|
|
- Include docstrings for public APIs
|
|
|
|
## Pull Request Process
|
|
|
|
1. Update documentation as needed
|
|
2. Add tests for new functionality
|
|
3. Ensure CI passes
|
|
4. Maintainers will review your code
|
|
5. Address review feedback
|
|
|
|
## Code of Conduct
|
|
|
|
Please note that this project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under the MIT License.
|