Skip to content

Commit 1510fda

Browse files
MatonAnthonyevanlucas
authored andcommittedNov 13, 2017
doc: outline commit message for breaking changes
Add informations to CONTRIBUTING.md requesting the committers and especially the one working on breaking changes to write proper commits messages containing the reason behind the breaking changes, the case during which it can be triggered, and a description of the breaking change in itself. PR-URL: #16846 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
1 parent 1ea546c commit 1510fda

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed
 

‎CONTRIBUTING.md

+9
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,14 @@ use `Refs:`.
334334
- `Refs: http://eslint.org/docs/rules/space-in-parens.html`
335335
- `Refs: https://github.com/nodejs/node/pull/3615`
336336

337+
5. If your commit introduces a breaking change (`semver-major`), it should
338+
contain an explanation about the reason of the breaking change, which
339+
situation would trigger the breaking change and what is the exact change.
340+
341+
Breaking changes will be listed in the wiki with the aim to make upgrading
342+
easier. Please have a look at [Breaking Changes](https://github.com/nodejs/node/wiki/Breaking-changes-between-v4-LTS-and-v6-LTS)
343+
for the level of detail that's suitable.
344+
337345
Sample complete commit message:
338346

339347
```txt
@@ -625,6 +633,7 @@ Focus first on the most significant aspects of the change:
625633
1. Does this change make sense for Node.js?
626634
2. Does this change make Node.js better, even if only incrementally?
627635
3. Are there clear bugs or larger scale issues that need attending to?
636+
4. Is the commit message readable and correct? If it contains a breaking change is it clear enough?
628637

629638
When changes are necessary, *request* them, do not *demand* them, and do not
630639
assume that the submitter already knows how to add a test or run a benchmark.

0 commit comments

Comments
 (0)
Please sign in to comment.