Skip to content

doc: note that PR-URL should be first metadata #6391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Trott wants to merge 3 commits into from
Closed

doc: note that PR-URL should be first metadata #6391

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb94126
doc: note that PR-URL should be first metadata
Trott Apr 26, 2016
89cadec
fix: reorder fixes/reviewed-by
jbergstroem Apr 26, 2016
eb41b3f
feature: order applies to all metadata values
jbergstroem Apr 26, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: note that PR-URL should be first metadata 
Convention has coalesced around putting the PR-URL as the first metadata
item in pull requests, so much so that collaborators are now flagging
other collaborators' commit messages when they don't do that. So let's
make it official and document that the PR-URL should be first.

Refs: nodejs/build#325
Refs: #6385
  • Loading branch information
@Trott
Trott committed Apr 26, 2016
commit eb9412624ab7d5af9ed7e4a1547252456541f309
7 changes: 4 additions & 3 deletions COLLABORATOR_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,12 @@ The CTC should serve as the final arbiter where required.
Always modify the original commit message to include additional meta
information regarding the change process:

- A `Reviewed-By: Name <email>` line for yourself and any
other Collaborators who have reviewed the change.
- A `PR-URL:` line that references the *full* GitHub URL of the original
pull request being merged so it's easy to trace a commit back to the
conversation that led up to that change.
conversation that led up to that change. Please be sure that the `PR-URL`
line appears first, above the `Reviewed-By` lines and any `Fixes` lines.
- A `Reviewed-By: Name <email>` line for yourself and any
other Collaborators who have reviewed the change.
- A `Fixes: X` line, where _X_ either includes the *full* GitHub URL
for an issue, and/or the hash and commit message if the commit fixes
a bug in a previous commit. Multiple `Fixes:` lines may be added if
Expand Down
4 changes: 2 additions & 2 deletions doc/onboarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,11 +164,11 @@ Landing a PR
* commits should follow `subsystem[,subsystem]: small description\n\nbig description\n\n<metadata>`
* first line 50 columns, all others 72
* add metadata:
* `PR-URL: <full-pr-url>` (this line should always be the first metadata line!)
* `Fixes: <full-issue-url>`
* `Reviewed-By: human <email>`
* Easiest to use `git log` then do a search
* (`/Name` + `enter` (+ `n` as much as you need to) in vim)
* `PR-URL: <full-pr-url>`
* `git push upstream master`
* close the original PR with "Landed in `<commit hash>`".

Expand All @@ -180,7 +180,7 @@ Landing a PR
* Collaborators in alphabetical order by username
* Label your pull request with the `doc` subsystem label
* If you would like to run CI on your PR, feel free to
* Make sure to added the `PR-URL: <full-pr-url>`!
* Make sure to add the `PR-URL: <full-pr-url>`!


### final notes:
Expand Down