From 1c85b45117ad2cb7979f8f6580be965227f9241f Mon Sep 17 00:00:00 2001 From: BO41 Date: Fri, 18 Oct 2019 16:55:08 +0000 Subject: [PATCH] Apply suggested wording to better describe the situation --- CONTRIBUTING.md | 6 ++++-- 1 file 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