From 6d6a65e2ad71f96976584f73bd73bb95d31d27d3 Mon Sep 17 00:00:00 2001 From: Sam Roberts Date: Fri, 10 Mar 2017 11:35:46 -0800 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/11792 Reviewed-By: Rich Trott Reviewed-By: Joyee Cheung Reviewed-By: Luigi Pinca Reviewed-By: Anna Henningsen Reviewed-By: James M Snell --- .github/PULL_REQUEST_TEMPLATE.md | 4 +++- CONTRIBUTING.md | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e14f5fc937d620..24b66f8b2f8b4d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,7 +13,9 @@ Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md - [ ] `make -j4 test` (UNIX), or `vcbuild test nosign` (Windows) passes - [ ] tests and/or benchmarks are included - [ ] documentation is changed or added -- [ ] commit message follows commit guidelines +- [ ] commit message follows [commit guidelines][] ##### Affected core subsystem(s) + +[commit guidelines]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#commit-guidelines diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 290cad8faaeb7a..923fb0299046fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,6 +95,8 @@ $ git add my/changed/files $ git commit ``` +### Commit guidelines + Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one: