Skip to content

Commit c805b7f

Browse files
committed
Add CONTRIBUTING.md
1 parent b121572 commit c805b7f

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to the MCP Python SDK! This document provides guidelines and instructions for contributing.
4+
5+
## Development Setup
6+
7+
1. Make sure you have Python 3.10+ installed
8+
2. Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
9+
3. Clone the repository:
10+
```bash
11+
git clone https://github.com/modelcontextprotocol/python-sdk.git
12+
cd python-sdk
13+
```
14+
4. Install dependencies:
15+
```bash
16+
uv sync --frozen --all-extras --dev
17+
```
18+
19+
## Development Workflow
20+
21+
1. Create a new branch for your changes
22+
2. Make your changes
23+
3. Ensure tests pass:
24+
```bash
25+
uv run pytest
26+
```
27+
4. Run type checking:
28+
```bash
29+
uv run pyright
30+
```
31+
5. Run linting:
32+
```bash
33+
uv run ruff check .
34+
uv run ruff format .
35+
```
36+
6. Submit a pull request
37+
38+
## Code Style
39+
40+
- We use `ruff` for linting and formatting
41+
- Follow PEP 8 style guidelines
42+
- Add type hints to all functions
43+
- Include docstrings for public APIs
44+
45+
## Pull Request Process
46+
47+
1. Update documentation as needed
48+
2. Add tests for new functionality
49+
3. Ensure CI passes
50+
4. Maintainers will review your code
51+
5. Address review feedback
52+
53+
## Code of Conduct
54+
55+
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.
56+
57+
## License
58+
59+
By contributing, you agree that your contributions will be licensed under the MIT License.

0 commit comments

Comments
 (0)