doc: link onboarding to contributing guide #8529
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
Replace the description of the commit message requirements in onboarding.md with a link to the commit message requirements as they appear in the CONTRIBUTING.md. Advantages include: * Only one place to keep the commit message requirements up to date * Most collaborators being onboarded will already have several commits in their name and already be familiar with the requirements. So repeating information here makes finding the new information (about metadata, for example) harder to find.
| * Commits should be of the form `subsystem[,subsystem]: small description\n\nbig description\n\n<metadata>` | ||
| * The first line should not exceed 50 characters. | ||
| * The remaining lines (except for metadata lines) should wrap at 72 characters. | ||
| * The commit message text must conform to the [guidelines for contributing](../CONTRIBUTING.md#step-3-commit). |
There was a problem hiding this comment.
Nit: s/guidelines for contributing/commit message guidelines/ ?
|
LGTM with a comment. |
|
changed wording per the one nit comment |
|
LGTM! |
gibfahn
approved these changes
Sep 14, 2016
lpinca
approved these changes
Sep 14, 2016
jbergstroem
approved these changes
Sep 14, 2016
|
LGTM (following protocol). |
|
LGTM |
imyller
approved these changes
Sep 15, 2016
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Sep 16, 2016
Replace the description of the commit message requirements in onboarding.md with a link to the commit message requirements as they appear in the CONTRIBUTING.md. Advantages include: * Only one place to keep the commit message requirements up to date * Most collaborators being onboarded will already have several commits in their name and already be familiar with the requirements. So repeating information here makes finding the new information (about metadata, for example) harder to find. PR-URL: nodejs#8529 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in 54dc719 |
Fishrock123
pushed a commit
that referenced
this pull request
Oct 11, 2016
Replace the description of the commit message requirements in onboarding.md with a link to the commit message requirements as they appear in the CONTRIBUTING.md. Advantages include: * Only one place to keep the commit message requirements up to date * Most collaborators being onboarded will already have several commits in their name and already be familiar with the requirements. So repeating information here makes finding the new information (about metadata, for example) harder to find. PR-URL: #8529 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com> Reviewed-By: James M Snell <jasnell@gmail.com>
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.
Checklist
Affected core subsystem(s)
doc
Description of change
Replace the description of the commit message requirements in
onboarding.md with a link to the commit message requirements as they
appear in the CONTRIBUTING.md.
Advantages include:
in their name and already be familiar with the requirements. So
repeating information here makes finding the new information (about
metadata, for example) harder to find.
/cc @lpinca