doc: update onboarding PR landing info #8479
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
Clarify a few items in the onboarding doc about landing a PR. One addition is to include the optionsl `Refs:` metadata.
| * Only include collaborators who have commented `LGTM` | ||
| * Amend the commit description. | ||
| * Commits should be of the form `subsystem[,subsystem]: small description\n\nbig description\n\n<metadata>` | ||
| * The first line should not exceed 50 characters. |
There was a problem hiding this comment.
Maybe specify that the description should use the imperative mood.
There was a problem hiding this comment.
I like it, but that gets a little trickier and starts leaking into other docs:
- Commit message formatting requirements are in
CONTRIBUTING.mdand belong there, IMO. This doc should just link to that section (except for metadata format, since that's Collaborator-specific). - The
CONTRIBUTING.mdshould include the imperative mood requirement. I don't think it does right now. So it will need to be updated too. - There may be some discussion around whether using the term
imperative moodwill be well-understood or is completely accurate. We may want to go with something more like "should start with a present-tense verb". Not sure but there seems to be a risk of bike-shedding.
For those reasons, if it's OK with you, I'd prefer to make the whole adjusting-the-requirements-for-the-commit-message thing be a separate pull request. (Feel free to open it yourself if you wish!)
There was a problem hiding this comment.
Commit message formatting requirements are in CONTRIBUTING.md and belong there, IMO.
I agree but in this case I would argue that the whole sentence ("The first line should not exceed 50 characters.") belongs to CONTRIBUTING.md.
That said, I'm totally fine with this as is, it's really nitpicking :)
mscdex
added
the
meta
| * `PR-URL: <full-pr-url>` | ||
| * `Reviewed-By: human <email>` |
There was a problem hiding this comment.
s/human/collaborator name/?
There was a problem hiding this comment.
Yes, I'll change human to collaborator name. Thanks!
|
LGTM |
1 similar comment
|
LGTM |
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Sep 13, 2016
Clarify a few items in the onboarding doc about landing a PR. One addition is to include the optional `Refs:` metadata. PR-URL: nodejs#8479 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in 4a42ae3 |
Fishrock123
pushed a commit
that referenced
this pull request
Sep 14, 2016
Clarify a few items in the onboarding doc about landing a PR. One addition is to include the optional `Refs:` metadata. PR-URL: #8479 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2 tasks
MylesBorins
pushed a commit
that referenced
this pull request
Sep 30, 2016
Clarify a few items in the onboarding doc about landing a PR. One addition is to include the optional `Refs:` metadata. PR-URL: #8479 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 10, 2016
Clarify a few items in the onboarding doc about landing a PR. One addition is to include the optional `Refs:` metadata. PR-URL: #8479 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
rvagg
pushed a commit
that referenced
this pull request
Oct 18, 2016
Clarify a few items in the onboarding doc about landing a PR. One addition is to include the optional `Refs:` metadata. PR-URL: #8479 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 26, 2016
Clarify a few items in the onboarding doc about landing a PR. One addition is to include the optional `Refs:` metadata. PR-URL: #8479 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Closed
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
Clarify a few items in the onboarding doc about landing a PR. One
addition is to include the optionsl
Refs:metadata.