chore: update CONTRIBUTING.md to replace incomplete release script with manual instruction. #100
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
Contributor
DevelopmentCats
commented
May 15, 2025
DevelopmentCats
commented
- Revised the release process description for better clarity.
- Added detailed steps for creating and pushing annotated tags.
- Updated notes on version numbering and publishing to the Coder Registry.
…ce automated release script is not complete - Revised the release process description for better clarity. - Added detailed steps for creating and pushing annotated tags. - Updated notes on version numbering and publishing to the Coder Registry.
matifali
reviewed
May 15, 2025
Comment on lines
+281
to
+287
| ### Version Numbers | ||
|
|
||
| Version numbers should follow semantic versioning: | ||
|
|
||
| - **Patch version** (1.2.3 → 1.2.4): Bug fixes | ||
| - **Minor version** (1.2.3 → 1.3.0): New features, adding inputs, deprecating inputs | ||
| - **Major version** (1.2.3 → 2.0.0): Breaking changes (removing inputs, changing input types) |
There was a problem hiding this comment.
This should actually be mentioned well before, for the author to put the correct tag in README.md. The maintainer would simply tag whatever tag is in the README while ensuring it's correct as per these rules and ask for changes if not.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.