Add VERSIONING.md, ROADMAP.md, and DEPENDENCY_POLICY.md (#2084)
This commit is contained in:
parent
66aaf93bcd
commit
b1adfcd885
1 changed files with 164 additions and 0 deletions
40
VERSIONING.md
Normal file
40
VERSIONING.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# Versioning Policy
|
||||
|
||||
The MCP Python SDK (`mcp`) follows [Semantic Versioning 2.0.0](https://semver.org/).
|
||||
|
||||
## Version Format
|
||||
|
||||
`MAJOR.MINOR.PATCH`
|
||||
|
||||
- **MAJOR**: Incremented for breaking changes (see below).
|
||||
- **MINOR**: Incremented for new features that are backward-compatible.
|
||||
- **PATCH**: Incremented for backward-compatible bug fixes.
|
||||
|
||||
## What Constitutes a Breaking Change
|
||||
|
||||
The following changes are considered breaking and require a major version bump:
|
||||
|
||||
- Removing or renaming a public API export (class, function, type, or constant).
|
||||
- Changing the signature of a public function or method in a way that breaks existing callers (removing parameters, changing required/optional status, changing types).
|
||||
- Removing or renaming a public type or dataclass/TypedDict field.
|
||||
- Changing the behavior of an existing API in a way that breaks documented contracts.
|
||||
- Dropping support for a Python version that is still receiving security updates.
|
||||
- Removing support for a transport type.
|
||||
- Changes to the MCP protocol version that require client/server code changes.
|
||||
|
||||
The following are **not** considered breaking:
|
||||
|
||||
- Adding new optional parameters to existing functions.
|
||||
- Adding new exports, types, or classes.
|
||||
- Adding new optional fields to existing types.
|
||||
- Bug fixes that correct behavior to match documented intent.
|
||||
- Internal refactoring that does not affect the public API.
|
||||
- Adding support for new MCP spec features.
|
||||
- Changes to dev dependencies or build tooling.
|
||||
|
||||
## How Breaking Changes Are Communicated
|
||||
|
||||
1. **Changelog**: All breaking changes are documented in the GitHub release notes with migration instructions.
|
||||
2. **Deprecation**: When feasible, APIs are deprecated for at least one minor release before removal using `warnings.warn()` with `DeprecationWarning`, which surfaces warnings at runtime and through static analysis tooling.
|
||||
3. **Migration guide**: Major version releases include a migration guide describing what changed and how to update.
|
||||
4. **PR labels**: Pull requests containing breaking changes are labeled with `breaking change`.
|
||||
Loading…
Reference in a new issue