diff options
| author | Gleb Nikonorov <gleb.i.nikonorov@gmail.com> | 2020-06-08 20:37:50 -0400 |
|---|---|---|
| committer | Gleb Nikonorov <gleb.i.nikonorov@gmail.com> | 2020-06-08 23:58:44 -0400 |
| commit | 96d4e2f571c59a6b22bf1a68c665ff5c08be87ef (patch) | |
| tree | 3e49e41d293f1d2ed1005a9b3e5bc687b66496f3 /CONTRIBUTING.rst | |
| parent | a76855912b599d53865c9019b10ae934875fbe04 (diff) | |
| download | pytest-96d4e2f571c59a6b22bf1a68c665ff5c08be87ef.tar.gz | |
Add documentation on closing issues
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 7 |
1 files changed, 7 insertions, 0 deletions
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! <bye> + +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 <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. + +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. |