Skip to content

Commit bd82de0

Browse files
authored
Rollup merge of rust-lang#65007 - BO41:keywords, r=nikomatsakis
Mention keyword closing policy closes rust-lang#59233 / rust-lang#59233 (comment) rewording suggestions welcome > Also in the referenced issue, the commit number of the new commit > that could close that issue is not really informative. The PR number itself appeared in the issue > is more informative and concise. @lzutao what do you mean with that? Is this fixed by the new "May be fixed by #XXXXX"?
2 parents 8699227 + 1c85b45 commit bd82de0

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,14 @@ the master branch to your feature branch.
128128
Also, please make sure that fixup commits are squashed into other related
129129
commits with meaningful commit messages.
130130

131+
GitHub allows [closing issues using keywords][closing-keywords]. This feature
132+
should be used to keep the issue tracker tidy. However, it is generally preferred
133+
to put the "closes #123" text in the PR description rather than the issue commit;
134+
particularly during rebasing, citing the issue number in the commit can "spam"
135+
the issue in question.
136+
137+
[closing-keywords]: https://help.github.com/en/articles/closing-issues-using-keywords
138+
131139
Please make sure your pull request is in compliance with Rust's style
132140
guidelines by running
133141

0 commit comments

Comments
 (0)