Update contributing guidelines to mention backwards compatibilty #447
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
Add a section to the CONTRIBUTING.md file to remind would-be contributors of the need to consider backwards compatibility, and to show how new slots should be tagged with the version of the spec they are introduced with. Also add a checkbox to the pull request template to remind contributors that new slots should be tagged as such.
The "overview" page had been moved quite a while ago, point to the "introduction" instead.
matentzn
approved these changes
May 21, 2025
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.
docs/have been added/updated if necessarymake testhas been run locallyThis PR updates the contributing guidelines to explain that changes to the model in the 1.x branch should be ideally limited to adding optional slots, and that added slots should be tagged with the
added_inannotation to indicate the version of the spec they will be introduced in.Arguably this could/should have been done as part of the PR in which the
sssom_versionslot was introduced (#440).