Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial draft of versioning guidelines #171

Merged
merged 8 commits into from Mar 16, 2019

Conversation

Projects
None yet
5 participants
@ghinks
Copy link
Contributor

ghinks commented Mar 8, 2019

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.


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.

This comment has been minimized.

@vweevers

vweevers Mar 8, 2019

IMO it should be more than a recommendation, it's a must. Bumping major takes no effort and prevents major pains.

This comment has been minimized.

@ghinks

ghinks Mar 9, 2019

Author Contributor

The wording will be changed to make it a required practice

Show resolved Hide resolved docs/drafts/versioning.md Outdated

ljharb and others added some commits Mar 9, 2019

Update docs/drafts/versioning.md
Co-Authored-By: ghinks <ghinks@yahoo.com>

@ghinks ghinks requested a review from ljharb Mar 9, 2019

Show resolved Hide resolved docs/drafts/versioning.md Outdated
Show resolved Hide resolved docs/drafts/versioning.md Outdated
Show resolved Hide resolved docs/drafts/versioning.md

mcollina and others added some commits Mar 9, 2019

Update docs/drafts/versioning.md
Co-Authored-By: ghinks <ghinks@yahoo.com>
Update docs/drafts/versioning.md
Co-Authored-By: ghinks <ghinks@yahoo.com>

reformatted and took on other comments which outdated request.

@mcollina
Copy link
Member

mcollina left a comment

LGTM

@Eomm

Eomm approved these changes Mar 16, 2019

breaking change and should be accompanied by major semver change.
- Release tag comments

This comment has been minimized.

@ljharb

ljharb Mar 16, 2019

Contributor

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.

This comment has been minimized.

@ghinks

ghinks Mar 16, 2019

Author Contributor

the originator wanted comments on the tag.

This comment has been minimized.

@mcollina

mcollina Mar 16, 2019

Member

I think it’s probably better called “release notes”.

This comment has been minimized.

@ljharb

ljharb Mar 16, 2019

Contributor

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.

This comment has been minimized.

@ghinks

ghinks Mar 16, 2019

Author Contributor

k, most reasonable.

@ghinks ghinks merged commit 82869ed into nodejs:master Mar 16, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.