Skip to content

Commit 6d6a65e

Browse files
sam-githubitaloacasas
authored andcommitted
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 <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 7c7228e commit 6d6a65e

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
1313
- [ ] `make -j4 test` (UNIX), or `vcbuild test nosign` (Windows) passes
1414
- [ ] tests and/or benchmarks are included
1515
- [ ] documentation is changed or added
16-
- [ ] commit message follows commit guidelines
16+
- [ ] commit message follows [commit guidelines][]
1717

1818
##### Affected core subsystem(s)
1919
<!-- 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

CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ $ git add my/changed/files
9595
$ git commit
9696
```
9797

98+
### Commit guidelines
99+
98100
Writing good commit logs is important. A commit log should describe what
99101
changed and why. Follow these guidelines when writing one:
100102

0 commit comments

Comments
 (0)