diff options
| author | Maton Anthony <MatonAnthony@users.noreply.github.com> | 2017-11-06 23:13:40 +0300 |
|---|---|---|
| committer | Franziska Hinkelmann <franziska.hinkelmann@gmail.com> | 2017-11-11 13:55:53 +0300 |
| commit | 2dcdd1d152b8f7d5c8371ca11d6c9e845a1e27a1 (patch) | |
| tree | 7985e1902863f03ba7c949e0a97a2e9b38f2a889 /CONTRIBUTING.md | |
| parent | fa86ebafa30f99ae385c8a952db0a701538c3477 (diff) | |
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: https://github.com/nodejs/node/pull/16846
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99278a843af..b234f935488 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -334,6 +334,14 @@ use `Refs:`. - `Refs: http://eslint.org/docs/rules/space-in-parens.html` - `Refs: https://github.com/nodejs/node/pull/3615` +5. If your commit introduces a breaking change (`semver-major`), it should +contain an explanation about the reason of the breaking change, which +situation would trigger the breaking change and what is the exact change. + +Breaking changes will be listed in the wiki with the aim to make upgrading +easier. Please have a look at [Breaking Changes](https://github.com/nodejs/node/wiki/Breaking-changes-between-v4-LTS-and-v6-LTS) +for the level of detail that's suitable. + Sample complete commit message: ```txt @@ -625,6 +633,7 @@ Focus first on the most significant aspects of the change: 1. Does this change make sense for Node.js? 2. Does this change make Node.js better, even if only incrementally? 3. Are there clear bugs or larger scale issues that need attending to? +4. Is the commit message readable and correct? If it contains a breaking change is it clear enough? When changes are necessary, *request* them, do not *demand* them, and do not assume that the submitter already knows how to add a test or run a benchmark. |