Skip to content

Commit a7d7042

Browse files
author
Giacomo Camporini
committed
Added paragraph for automatically closing issues
1 parent c8e5bf5 commit a7d7042

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/source/contributing.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,14 @@ to get feedback on, feel free to submit it as a PR. (In this case it's
167167
traditional to start the PR title with ``[WIP]``, for "work in
168168
progress".)
169169

170+
When you are submitting your PR, you can include ``Closes #123``,
171+
``Fixes: #123`` or
172+
`some variation <https://help.github.com/en/articles/closing-issues-using-keywords>`__
173+
in either your commit message or the PR description, in order to
174+
automatically close the issue you are solving when the PR is merged.
175+
This is not mandatory, but it helps cleaning up and prevents dangling issues
176+
that have to be closed by people coming across them in the future.
177+
170178

171179
.. _pull-request-tests:
172180

0 commit comments

Comments
 (0)