Skip to content

Commit f81bd48

Browse files
gibfahnitaloacasas
authored andcommitted
doc: document use of Refs: for references
Standardise on Refs: PR-URL: #10670 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Yorkie Liu <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Sam Roberts <[email protected]>
1 parent b70dde0 commit f81bd48

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

COLLABORATOR_GUIDE.md

+1
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ information regarding the change process:
120120
for an issue, and/or the hash and commit message if the commit fixes
121121
a bug in a previous commit. Multiple `Fixes:` lines may be added if
122122
appropriate.
123+
- A `Refs:` line referencing a URL for any relevant background.
123124
- A `Reviewed-By: Name <email>` line for yourself and any
124125
other Collaborators who have reviewed the change.
125126
- Useful for @mentions / contact list if something goes wrong in the PR.

CONTRIBUTING.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,13 @@ Check the output of `git log --oneline files_that_you_changed` to find out
136136
what subsystem (or subsystems) your changes touch.
137137

138138
If your patch fixes an open issue, you can add a reference to it at the end
139-
of the log. Use the `Fixes:` prefix and the full issue URL. For example:
139+
of the log. Use the `Fixes:` prefix and the full issue URL. For other references
140+
use `Refs:`. For example:
140141

141142
```txt
142143
Fixes: https://github.com/nodejs/node/issues/1337
144+
Refs: http://eslint.org/docs/rules/space-in-parens.html
145+
Refs: https://github.com/nodejs/node/pull/3615
143146
```
144147

145148
### Step 4: Rebase

0 commit comments

Comments
 (0)