From 96d4e2f571c59a6b22bf1a68c665ff5c08be87ef Mon Sep 17 00:00:00 2001 From: Gleb Nikonorov Date: Mon, 8 Jun 2020 20:37:50 -0400 Subject: [PATCH] Add documentation on closing issues --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++++ CONTRIBUTING.rst | 7 +++++++ 2 files changed, 11 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d189f7869..9408fceaf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,6 +7,10 @@ Here is a quick checklist that should be present in PRs. - [ ] Include new tests or update existing tests when applicable. - [X] Allow maintainers to push and squash when merging my commits. Please uncheck this if you prefer to squash the commits yourself. +If this change fixes an issue, please: + +- [ ] Add text like ``closes #XYZW`` to the PR description and/or commits (where ``XYZW`` is the issue number). See the [github docs](https://help.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) for more information. + Unless your change is trivial or a small documentation fix (e.g., a typo or reword of a small section) please: - [ ] Create a new changelog file in the `changelog` folder, with a name like `..rst`. See [changelog/README.rst](https://github.com/pytest-dev/pytest/blob/master/changelog/README.rst) for details. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d5bd78144..5e309a317 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -418,3 +418,10 @@ When closing a Pull Request, it needs to be acknowledge the time, effort, and in Again we appreciate your time for working on this, and hope you might get back to this at a later time! + +Closing Issues +-------------- + +When a pull request is submitted to fix an issue, add text like ``closes #XYZW`` to the PR description and/or commits (where ``XYZW`` is the issue number). See the `GitHub docs `_ for more information. + +When an issue is due to user error (e.g. misunderstanding of a functionality), please politely explain to the user why the issue raised is really a non-issue and ask them to close the issue if they have no further questions. If the original requestor is unresponsive, the issue will be handled as described in the section `Handling stale issues/PRs`_ above.