docs: update semantic versioning #1203
Merged
Conversation
This file contains 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
shaspitz
reviewed
Aug 14, 2023
There was a problem hiding this comment.
These seem like valid guidelines to implement for consumer/provider modules separately once #801 is completed. For now, we should add "for consumer OR provider" in each of the bullet points and they will share a semver cycle as defined
Co-authored-by: Shawn <[email protected]>
Co-authored-by: Shawn <[email protected]>
p-offtermatt
approved these changes
Aug 16, 2023
|
|
||
| Incrementing a PATCH version number indicates that a PR is not consensus breaking to the provider or consumers. This could include node API changes, or other miscellaneous and often rare changes. | ||
|
|
||
| Pure documentation, testing, and refactoring PRs do not require a version bump. |
There was a problem hiding this comment.
Should we keep this, just to clarify?
There was a problem hiding this comment.
I'm not sure that I agree with the sentence:
Pure documentation
we should have versioned docs
testing
We shouldn't release code without testing. If we improved just the testing, we can cut a new patch release with the code better tested or just don't release anything yet. Not every PR needs a release.
refactoring
Same as for testing.
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.
Description
Closes: NA
Update docs re. semantic versioning to follow ibc-go approach: https://github.com/cosmos/ibc-go/blob/main/RELEASES.md
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
docs:prefix in the PR titleReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
docs:prefix in the PR titlemake build-docs)