SEP-1309: Add spec and SDK versioning guidelines #1404
+75
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -5,7 +5,10 @@ weight: 10 | |||
| --- | |||
|
|
|||
| The Model Context Protocol uses string-based version identifiers following the format | |||
| `YYYY-MM-DD`, to indicate the last date backwards incompatible changes were made. | |||
| `YYYY-MM-DD`, to indicate the last date backwards incompatible changes were made. All | |||
| specification versions **MUST** be accompanied by detailed release notes to alert the | |||
There was a problem hiding this comment.
IMO this whole page should be removed or rewritten, as in its current form it's just a less-useful version of the specification section on version negotiation. Leaving that out of scope -- I think this addition, along with the new section below, both belong on somewhere under the Community tab, likely under the Processes section on the Governance page.
If this moves there (or even if it stays here in the docs) it should maybe even do away with RFC2119-style language, as that's more appropriate for the technical specification.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
This PR adds the specification and SDK versioning guidelines introduced in the accepted #1309 to the specification documentation.
How Has This Been Tested?
Tested locally using the instructions in CONTRIBUTING.md.
Breaking Changes
None
Types of changes
Checklist
Additional context
There is some confusion regarding the best place to add these guidelines. The implementation tracking matrix should live in the SDKs section under Documentation tab. However, I am open to suggestion for the versioning guidelines. Currently I have added them in the Versioning section under Documentation tab. There can also be a case made to break them up and add them to the Governance and Stewardship section under the Community tab or to actually add them within the Specification tab somewhere near the Version Negotiation guidelines. Open to feedback on this.