diff options
author | Sam Roberts <vieuxtech@gmail.com> | 2017-03-10 22:35:46 +0300 |
---|---|---|
committer | James M Snell <jasnell@gmail.com> | 2017-03-17 01:42:57 +0300 |
commit | 303962aca192e28b5ec5a74da9f53d9f26e52359 (patch) | |
tree | ad2d036774ec9323e1ed388287110c5dcbfd291c /CONTRIBUTING.md | |
parent | 5e3d536ea30528c79ecc4a8b36425f82285e03d1 (diff) |
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 <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>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 290cad8faae..923fb029904 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: |