From cabcd99476060b4e293f3031dafe7d84a557768d Mon Sep 17 00:00:00 2001 From: BO41 Date: Wed, 2 Oct 2019 17:55:06 +0200 Subject: [PATCH 1/3] Mention keyword closing policy --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4daaa986a2d..d796dc18032 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -129,6 +129,12 @@ the master branch to your feature branch. 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 features +should be used to keep the issue tracker tidy. But in pull requests only. Please +do not add this to your commit message. + +[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 From 59ce359c8f5f6f9a373ca5be82a3b96527b38b9e Mon Sep 17 00:00:00 2001 From: BO41 Date: Wed, 2 Oct 2019 21:31:00 +0000 Subject: [PATCH 2/3] Fix typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d796dc18032..caf003d183a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -129,7 +129,7 @@ the master branch to your feature branch. 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 features +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. From 1c85b45117ad2cb7979f8f6580be965227f9241f Mon Sep 17 00:00:00 2001 From: BO41 Date: Fri, 18 Oct 2019 16:55:08 +0000 Subject: [PATCH 3/3] 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