Skip to content

Commit 9fcdafc

Browse files
committed
Clarify format of the PR number
1 parent 2df6c45 commit 9fcdafc

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/developer/pr-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The recommended way to use this document is to copy the relevant checklists belo
88

99
Every PR should add a new file in the appropriate subdirectory of `changelog.d`, containing just the text of the corresponding changelog entry. There is no need to explicitly write a PR number, because the `mk-changelog.sh` script (used on release) will add it automatically at the end. The name of the file does not matter, but it should be unique to avoid unnecessary conflicts (e.g. use the branch name).
1010

11-
It is still possible to write the PR number manually if so desired, which is useful in case the entry is shared by multiple PRs. In that case, the script would leave the PR number reference intact, as long as it is at the very end of the entry, with no period afterwards and in brackets. It is also possible to use the pattern `##` to refer to the current PR number. This will be replaced throughout.
11+
It is still possible to write the PR number manually if so desired, which is useful in case the entry is shared by multiple PRs. In that case, the script would leave the PR number reference intact, as long as it is at the very end of the entry, with no period afterwards, in brackets, and preceded by a `#` symbol (e.g. #2646). It is also possible to use the pattern `##` to refer to the current PR number. This will be replaced throughout.
1212

1313
Multiline entries are supported, and are handled correctly by the script. Again, the PR reference should either be omitted or put at the very end. If multiple entries for a single PR are desired, there should be a different file for each of them.
1414

0 commit comments

Comments
 (0)