You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: improve contributing guidelines with clearer structure
- Add explanation of why issues are required (maintenance burden)
- Replace label paragraph with table showing who each label is for
- Add guidance to comment on issues before starting work
- Expand PR section with scope guidance and rejection criteria
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+29-7Lines changed: 29 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Thank you for your interest in contributing to the MCP Python SDK! This document
6
6
7
7
We welcome contributions! These guidelines exist to save everyone time, yours included. Following them means your work is more likely to be accepted.
8
8
9
-
**All pull requests require a corresponding issue.** Unless your change is trivial (typo, docs tweak, broken link), create an issue first. PRs without a linked issue will be closed.
9
+
**All pull requests require a corresponding issue.** Unless your change is trivial (typo, docs tweak, broken link), create an issue first. Every merged feature becomes ongoing maintenance, so we need to agree something is worth doing before reviewing code. PRs without a linked issue will be closed.
10
10
11
11
Having an issue doesn't guarantee acceptance. Wait for maintainer feedback or a `ready for work` label before starting. PRs for issues without buy-in may also be closed.
12
12
@@ -27,11 +27,17 @@ These always require an issue first:
27
27
28
28
Bug fixes for clear, reproducible issues are welcome—but still create an issue to track the fix.
29
29
30
-
### Good Candidates for Contribution
30
+
### Finding Issues to Work On
31
31
32
-
Issues labeled [`good first issue`](https://github.com/modelcontextprotocol/python-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) or [`help wanted`](https://github.com/modelcontextprotocol/python-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) are great starting points. Issues labeled [`ready for work`](https://github.com/modelcontextprotocol/python-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22ready+for+work%22) have been triaged and are ready for implementation.
32
+
| Label | For | Description |
33
+
|-------|-----|-------------|
34
+
|[`good first issue`](https://github.com/modelcontextprotocol/python-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)| Newcomers | Can tackle without deep codebase knowledge |
35
+
|[`help wanted`](https://github.com/modelcontextprotocol/python-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)| Experienced contributors | Maintainers probably won't get to this |
36
+
|[`ready for work`](https://github.com/modelcontextprotocol/python-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22ready+for+work%22)| Maintainers | Triaged and ready for a maintainer to pick up |
33
37
34
-
Issues labeled `needs confirmation` or `needs maintainer action` are **not** good candidates—wait for maintainer input before starting work.
38
+
Issues labeled `needs confirmation` or `needs maintainer action` are **not** ready for work—wait for maintainer input first.
39
+
40
+
Before starting, comment on the issue so we can assign it to you. This prevents duplicate effort.
35
41
36
42
## Development Setup
37
43
@@ -102,13 +108,29 @@ pre-commit run --all-files
102
108
- Add type hints to all functions
103
109
- Include docstrings for public APIs
104
110
105
-
## Pull Request Process
111
+
## Pull Requests
112
+
113
+
By the time you open a PR, the "what" and "why" should already be settled in an issue. This keeps reviews focused on implementation.
114
+
115
+
### Scope
116
+
117
+
Small PRs get reviewed fast. Large PRs sit in the queue.
118
+
119
+
A few dozen lines can be reviewed in minutes. Hundreds of lines across many files takes real effort and things slip through. If your change is big, break it into smaller PRs or get alignment from a maintainer first.
120
+
121
+
### What Gets Rejected
122
+
123
+
-**No prior discussion**: Features or significant changes without an approved issue
124
+
-**Scope creep**: Changes that go beyond what was discussed
125
+
-**Misalignment**: Even well-implemented features may be rejected if they don't fit the SDK's direction
126
+
-**Overengineering**: Unnecessary complexity for simple problems
0 commit comments