doc: linkable commit message guidelines #11792
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
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.
sam-github
force-pushed
the
link-commit-message-guidelines
branch
from
df2c050
to
6865119
Compare
Trott
approved these changes
Mar 10, 2017
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. |
joyeecheung
approved these changes
Mar 11, 2017
lpinca
approved these changes
Mar 11, 2017
addaleax
approved these changes
Mar 11, 2017
| @@ -95,6 +95,8 @@ $ git add my/changed/files | |||
| $ git commit | |||
| ``` | |||
|
|
|||
| ### Commit guidelines | |||
There was a problem hiding this comment.
Maybe Commit message guidelines is a bit more accurate?
jasnell
approved these changes
Mar 11, 2017
|
This looks like a subsection of #11732 |
2 tasks
jasnell
pushed a commit
that referenced
this pull request
Mar 16, 2017
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 |
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Mar 20, 2017
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>
jungx098
pushed a commit
to jungx098/node
that referenced
this pull request
Mar 21, 2017
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)