doc: linkable commit message guidelines#11792
doc: linkable commit message guidelines#11792sam-github wants to merge 2 commits intonodejs:masterfrom
Conversation
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.
df2c050 to
6865119
Compare
Trott
left a comment
There was a problem hiding this comment.
LGTM although I'd like it better if the link text and the header text were more similar. If I click "commit guidelines" and end up looking at a section called "Required format for commit logs", I might wonder if I got linked to the middle of the section I was supposed to land in and start scrolling up...
|
@Trott Agreed, fixed. |
| $ git commit | ||
| ``` | ||
|
|
||
| ### Commit guidelines |
There was a problem hiding this comment.
Maybe Commit message guidelines is a bit more accurate?
|
This looks like a subsection of #11732 |
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>
|
Landed in 303962a |
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: nodejs#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>
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: nodejs#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>
|
This does not land cleanly in LTS. Please feel free to manually backport. Please also feel free to replace the backport request label with do-not-land if it shouldn't land |
|
Can't see a reason to land. I think only the version on master is used by github for the templates. |
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.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)