diff options
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c719a81b..dad3e4ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,12 @@ When possible, fill out as much detail in the pull request template as is reasonable. Most important is to reference the GitHub issue that you are addressing with the PR. +**NOTE:** GitHub has [a feature](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) +that will automatically close issues referenced with a keyword (such as "Fixes") +by a PR or commit once the PR/commit is merged. Don't use these keywords. We +don't want issues to be automatically closed. We want our testers to +independently verify and close them. + ## Writing good commit messages Having clear, concise and well-written commit messages for all changes is not |