Skip to content

doc: linkable commit message guidelines - #11792

Closed
sam-github wants to merge 2 commits into
nodejs:masterfrom
sam-github:link-commit-message-guidelines
Closed

doc: linkable commit message guidelines#11792
sam-github wants to merge 2 commits into
nodejs:masterfrom
sam-github:link-commit-message-guidelines

Conversation

@sam-github

Copy link
Copy Markdown
Contributor

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), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. labels Mar 10, 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.
@sam-github
sam-githubforce-pushed the link-commit-message-guidelines branch from df2c050 to 6865119CompareMarch 10, 2017 19:45

@TrottTrott left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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...

@sam-github

Copy link
Copy Markdown
ContributorAuthor

@Trott Agreed, fixed.

Comment threadCONTRIBUTING.md
$ git commit
```

### Commit guidelines

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe Commit message guidelines is a bit more accurate?

@gibfahn

Copy link
Copy Markdown
Member

This looks like a subsection of #11732

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>
@jasnell

Copy link
Copy Markdown
Member

Landed in 303962a

@jasnelljasnell closed this Mar 16, 2017
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>
@italoacasasitaloacasas mentioned this pull request Mar 20, 2017
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>
@sam-github
sam-github deleted the link-commit-message-guidelines branch April 17, 2017 20:24
@MylesBorins

Copy link
Copy Markdown
Contributor

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

@sam-github

Copy link
Copy Markdown
ContributorAuthor

Can't see a reason to land. I think only the version on master is used by github for the templates.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.metaIssues and PRs related to the general management of the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants

@sam-github@gibfahn@jasnell@MylesBorins@Trott@addaleax@lpinca@joyeecheung@nodejs-github-bot