| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent ecd2b52 commit 5bec1eb
1 file changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -178,18 +178,24 @@ Landing a PR | |||
| 178 | 178 | * `git rebase -i upstream/master` | |
| 179 | 179 | * squash into logical commits if necessary | |
| 180 | 180 | * `./configure && make -j8 test` (`-j8` builds node in parallel with 8 threads. adjust to the number of cores (or processor-level threads) your processor has (or slightly more) for best results.) | |
| 181 | - * Amend the commit description | ||
| 182 | - * commits should follow `subsystem[,subsystem]: small description\n\nbig description\n\n<metadata>` | ||
| 183 | - * first line 50 columns, all others 72 | ||
| 184 | - * add metadata: | ||
| 185 | - * `Fixes: <full-issue-url>` | ||
| 186 | - * `Reviewed-By: human <email>` | ||
| 187 | - * Easiest to use `git log` then do a search | ||
| 188 | - * (`/Name` + `enter` (+ `n` as much as you need to) in vim) | ||
| 189 | - * Only include collaborators who have commented `LGTM` | ||
| 181 | + * Amend the commit description. | ||
| 182 | + * Commits should be of the form `subsystem[,subsystem]: small description\n\nbig description\n\n<metadata>` | ||
| 183 | + * The first line should not exceed 50 characters. | ||
| 184 | + * The remaining lines (except for metadata lines) should wrap at 72 characters. | ||
| 185 | + * Add required metadata: | ||
| 190 | 186 | * `PR-URL: <full-pr-url>` | |
| 187 | + * `Reviewed-By: <collaborator name> <collaborator email>` | ||
| 188 | + * Easiest to use `git log`, then do a search. | ||
| 189 | + * In vim: `/Name` + `enter` (+ `n` as much as you need to) | ||
| 190 | + * Only include collaborators who have commented `LGTM`. | ||
| 191 | + * Add additional metadata as appropriate: | ||
| 192 | + * `Fixes: <full-issue-url>` | ||
| 193 | + * Full URL of GitHub issue that the PR fixes. | ||
| 194 | + * This will automatically close the PR when the commit lands in master. | ||
| 195 | + * `Refs: <full-url>` | ||
| 196 | + * Full URL of material that might provide additional useful information or context to someone trying to understand the change set or the thinking behind it. | ||
| 191 | 197 | * `git push upstream master` | |
| 192 | - * close the original PR with "Landed in `<commit hash>`". | ||
| 198 | + * Close the pull request with a "Landed in `<commit hash>`" comment. | ||
| 193 | 199 | ||
| 194 | 200 | ||
| 195 | 201 | ## Exercise: Make a PR adding yourself to the README | |
| Back | FazBrowse Home | New Git URL |
0 commit comments