From 68651197e84057fbd5caab440fd3f100c5d4e15b Mon Sep 17 00:00:00 2001 From: Sam Roberts Date: Fri, 10 Mar 2017 11:35:46 -0800 Subject: [PATCH 1/2] 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. --- .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 f62bb1d118d76c..a6894ce4841c97 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` (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#required-format-for-commit-logs diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 290cad8faaeb7a..c4f8cc206fe708 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,6 +95,8 @@ $ git add my/changed/files $ git commit ``` +### Required format for commit logs + Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one: From c9b4d95952110230017cbe1f376308a4aafbcb27 Mon Sep 17 00:00:00 2001 From: Sam Roberts Date: Fri, 10 Mar 2017 16:38:49 -0800 Subject: [PATCH 2/2] fixup! doc: linkable commit message guidelines --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a6894ce4841c97..4b37b8325063ef 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,4 +18,4 @@ Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md ##### Affected core subsystem(s) -[commit guidelines]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#required-format-for-commit-logs +[commit guidelines]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#commit-guidelines diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4f8cc206fe708..923fb0299046fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,7 +95,7 @@ $ git add my/changed/files $ git commit ``` -### Required format for commit logs +### Commit guidelines Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one: