diff options
| author | Matthias Beyer <matthias.beyer@ifm.com> | 2022-09-01 11:24:26 +0200 |
|---|---|---|
| committer | Matthias Beyer <matthias.beyer@ifm.com> | 2022-09-01 17:46:59 +0200 |
| commit | 235c78e50c00b0f7cf9a9bbe179aa580a708ce86 (patch) | |
| tree | 9cede0024d10aa0231e34f68afdfeb4556dcc529 | |
| parent | 65e743526cd443805b808472cafa930e9136f15e (diff) | |
Revert "Remove section on auto-close functionality"
After discussion we agreed to not remove this paragraph for now.
This reverts commit 115d23af7811a49f088534a9645601b6de373312.
Suggested-by: Didier Wenzek <didier.wenzek@free.fr>
Signed-off-by: Matthias Beyer <matthias.beyer@ifm.com>
| -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 |