Auto merge of #65938 - eddyb:fn-abi-rename, r=oli-obk

[rust.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c3a9a68963eb78136179bb5478c732b7d869e91a..37a217d2a04523fb53a3cc1c1ed6031ca2ff787b 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -128,6 +128,14 @@ the master branch to your feature branch.
 Also, please make sure that fixup commits are squashed into other related
 commits with meaningful commit messages.
 
 Also, please make sure that fixup commits are squashed into other related
 commits with meaningful commit messages.
 

+GitHub allows [closing issues using keywords][closing-keywords]. This feature
+should be used to keep the issue tracker tidy. However, it is generally preferred
+to put the "closes #123" text in the PR description rather than the issue commit;
+particularly during rebasing, citing the issue number in the commit can "spam"
+the issue in question.
+
+[closing-keywords]: https://help.github.com/en/articles/closing-issues-using-keywords
+

 Please make sure your pull request is in compliance with Rust's style
 guidelines by running
 
 Please make sure your pull request is in compliance with Rust's style
 guidelines by running