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

Document process for Semver Major Changes and Deprecation Policy #7912

Closed
MylesBorins opened this issue Jul 28, 2016 · 5 comments
Closed

Document process for Semver Major Changes and Deprecation Policy #7912

MylesBorins opened this issue Jul 28, 2016 · 5 comments
Assignees
Labels
doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.

Comments

@MylesBorins
Copy link
Contributor

MylesBorins commented Jul 28, 2016

It would be a good idea for us to document a policy for how Semver Major changes are landed and how deprecations are handled.

@isaacs has offered to write some copy, which I think should live in our collaborator guide

@nodejs/ctc please chime in with your thoughts on this.

@MylesBorins MylesBorins added doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. labels Jul 28, 2016
@MylesBorins MylesBorins mentioned this issue Jul 28, 2016
2 tasks
@MylesBorins MylesBorins changed the title Document process for Semver Major Changes Document process for Semver Major Changes and Deprecation Policy Jul 28, 2016
@evanlucas
Copy link
Contributor

+1 from me. I think that we should have this better documented. We seem to have run into issues a few times now related to breaking changes.

@jasnell jasnell self-assigned this Jul 29, 2016
@jasnell
Copy link
Member

jasnell commented Jul 29, 2016

Having a documented policy would be definitely be good. We do need to make sure, however, that it includes the flexibility for us to make certain necessary semver-major changes without requiring a full deprecation cycle, however, as that would simply make things far too difficult to manage over time.

As a related aside,
One key thing that I would like to see is for every semver-major to be tagged to a specific milestone, and for there to be some mechanism of actively calling special attention to semver-major commits that land in master. Perhaps this can be done via more commit metadata? Currently, in order to know if a commit is semver-major without generating the changelog we have to click through to the underlying PR, which gets a bit tedious. Perhaps the semver-iness of any particular commit can be specified explicitly in the commit metadata itself:

e.g.

Semver: major | minor
PR-URL: ...
Reviewed-By: ...

@ChALkeR
Copy link
Member

ChALkeR commented Jul 29, 2016

+1 to both of those — documenting the process and commit comments.

Currently, in order to know if a commit is semver-major without generating the changelog we have to click through to the underlying PR, which gets a bit tedious.

That can also result in false positives, if a «semver-major»/«semver-minor» PR includes several commits, only part of which are actually semver-major/semver-minor. E.g. #7562 was the case.

@jasnell jasnell mentioned this issue Aug 5, 2016
2 tasks
@MylesBorins MylesBorins changed the title Document process for Semver Major Changes and Deprecation Policy Document process for Semver Major Changes Apr 26, 2017
@MylesBorins
Copy link
Contributor Author

MylesBorins commented Apr 26, 2017

Changed title as it appears we have documentation for deprecation policy now

edit: lol nvm that was the old issue.

@MylesBorins MylesBorins changed the title Document process for Semver Major Changes Document process for Semver Major Changes and Deprecation Policy Apr 26, 2017
@Trott
Copy link
Member

Trott commented Aug 4, 2017

Semver changes policy: Included under https://github.com/nodejs/node/blob/3702ae732eadd9d7c64681edcdd76cd7a30f6381/COLLABORATOR_GUIDE.md#accepting-modifications.

Deprecation policy: https://github.com/nodejs/node/blob/3702ae732eadd9d7c64681edcdd76cd7a30f6381/COLLABORATOR_GUIDE.md#deprecations.

If there's stuff missing, feel free to re-open and specify what's missing or open a new issue. Or if I'm just misguided for closing this, re-open. :-D

@Trott Trott closed this as completed Aug 4, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

No branches or pull requests

6 participants