about summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorBO41 <botbob@disroot.org>2019-10-18 16:55:08 +0000
committerGitHub <noreply@github.com>2019-10-18 16:55:08 +0000
commit1c85b45117ad2cb7979f8f6580be965227f9241f (patch)
tree3e062672174b4195808108c886e937f7e602812c /CONTRIBUTING.md
parent59ce359c8f5f6f9a373ca5be82a3b96527b38b9e (diff)
downloadrust-1c85b45117ad2cb7979f8f6580be965227f9241f.tar.gz
rust-1c85b45117ad2cb7979f8f6580be965227f9241f.zip
Apply suggested wording
to better describe the situation
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index caf003d183a..add4338771e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -130,8 +130,10 @@ 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. But in pull requests only. Please
-do not add this to your commit message.
+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