Skip to content

Commit 1c85b45

Browse files
author
BO41
authored
Apply suggested wording
to better describe the situation
1 parent 59ce359 commit 1c85b45

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

CONTRIBUTING.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,10 @@ Also, please make sure that fixup commits are squashed into other related
130130
commits with meaningful commit messages.
131131

132132
GitHub allows [closing issues using keywords][closing-keywords]. This feature
133-
should be used to keep the issue tracker tidy. But in pull requests only. Please
134-
do not add this to your commit message.
133+
should be used to keep the issue tracker tidy. However, it is generally preferred
134+
to put the "closes #123" text in the PR description rather than the issue commit;
135+
particularly during rebasing, citing the issue number in the commit can "spam"
136+
the issue in question.
135137

136138
[closing-keywords]: https://help.github.com/en/articles/closing-issues-using-keywords
137139

0 commit comments

Comments
 (0)