Skip to content

Commit 4b36f14

Browse files
committed
doc: request better 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.
1 parent fb31e07 commit 4b36f14

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,10 @@ 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 introduce a breaking change (`semver-major`), it should contain
338+
an explanation about the reason of the breaking change, which situation would trigger
339+
the breaking change and what is the exact change.
340+
337341
Sample complete commit message:
338342

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

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

0 commit comments

Comments
 (0)