Commit 6d6a65e
doc: linkable commit message guidelines
Put the commit guidelines themselves under a heading to be more
prominent, and to allow linking directly to them (instead of the section
on how to use git).
Link the pull request template to the guidelines, so contributors can
find them.
PR-URL: #11792
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 7c7228e commit 6d6a65e
2 files changed
Lines changed: 5 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -13,7 +13,9 @@ Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md | |||
| 13 | 13 | - [ ] `make -j4 test` (UNIX), or `vcbuild test nosign` (Windows) passes | |
| 14 | 14 | - [ ] tests and/or benchmarks are included | |
| 15 | 15 | - [ ] documentation is changed or added | |
| 16 | - - [ ] commit message follows commit guidelines | ||
| 16 | + - [ ] commit message follows [commit guidelines][] | ||
| 17 | 17 | ||
| 18 | 18 | ##### Affected core subsystem(s) | |
| 19 | 19 | <!-- Provide affected core subsystem(s) (like doc, cluster, crypto, etc). --> | |
| 20 | + | ||
| 21 | + [commit guidelines]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#commit-guidelines | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -95,6 +95,8 @@ $ git add my/changed/files | |||
| 95 | 95 | $ git commit | |
| 96 | 96 | ``` | |
| 97 | 97 | ||
| 98 | + ### Commit guidelines | ||
| 99 | + | ||
| 98 | 100 | Writing good commit logs is important. A commit log should describe what | |
| 99 | 101 | changed and why. Follow these guidelines when writing one: | |
| 100 | 102 | ||
0 commit comments