initial draft of versioning guidelines #171
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
Eomm
reviewed
Mar 8, 2019
vweevers
reviewed
Mar 8, 2019
docs/drafts/versioning.md
Outdated
|
|
||
| The package maintenance group recommends that supported packages follow the issued NPM [best practices](https://docs.npmjs.com/about-semantic-versioning). Most packages that receive help are expected to already be following this guidance. However if a package is not already on a major semver release number we suggest that bumping up to version 1.0.0 on the next semver major release. | ||
|
|
||
| It is also recommended that increasing the minimum required version of node is a breaking change and should be accompanied by major semver change. |
There was a problem hiding this comment.
IMO it should be more than a recommendation, it's a must. Bumping major takes no effort and prevents major pains.
There was a problem hiding this comment.
The wording will be changed to make it a required practice
ljharb
previously requested changes
Mar 8, 2019
Co-Authored-By: ghinks <ghinks@yahoo.com>
ljharb
reviewed
Mar 9, 2019
mcollina
reviewed
Mar 9, 2019
Co-Authored-By: ghinks <ghinks@yahoo.com>
Co-Authored-By: ghinks <ghinks@yahoo.com>
ghinks
dismissed
ljharb’s stale review
reformatted and took on other comments which outdated request.
Eomm
approved these changes
Mar 16, 2019
ljharb
reviewed
Mar 16, 2019
docs/drafts/versioning.md
Outdated
| breaking change and should be accompanied by major semver change. | ||
| - Release tag comments |
There was a problem hiding this comment.
what does this mean? Certainly there should be a semver tag on each published version - I’m not sure if this is what’s meant here.
There was a problem hiding this comment.
the originator wanted comments on the tag.
There was a problem hiding this comment.
I think it’s probably better called “release notes”.
There was a problem hiding this comment.
That would then be:
- release notes, in at least one of or possibly all of: in the commit message that bumps the version; in a changelog file in the version bump commit; in the tag annotation for the semver-tagged published commit.
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.
Issue 158 versioning discourse has resulted in this brief advice for versioning. We are separating the versioning advice from the associated tooling that would or could enforce versioning.