Skip to content

Commit

Permalink
Apply suggested wording
Browse files Browse the repository at this point in the history
to better describe the situation
  • Loading branch information
BO41 committed Oct 18, 2019
1 parent 59ce359 commit 1c85b45
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 1c85b45

Please sign in to comment.