8000 DOC Encourage contributors to use keywords to close issue automatical… · jwjohnson314/scikit-learn@cf7109e · GitHub
[go: up one dir, main page]

Skip to content

Commit cf7109e

Browse files
qinhanmin2014Jeremiah Johnson
authored andcommitted
DOC Encourage contributors to use keywords to close issue automatically (scikit-learn#9954)
1 parent c35d333 commit cf7109e

File tree

3 files changed

+36
-10
lines changed

3 files changed

+36
-10
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,19 @@ following rules before you submit a pull request:
7070
[Utilities for Developers](http://scikit-learn.org/dev/developers/utilities.html#developers-utils)
7171
page.
7272

73-
- If your pull request addresses an issue, please use the pull request title
74-
to describe the issue and mention the issue number in the pull request description. This will make sure a link back to the original issue is
75-
created.
73+
- Give your pull request a helpful title that summarises what your
74+
contribution does. In some cases `Fix <ISSUE TITLE>` is enough.
75+
`Fix #<ISSUE NUMBER>` is not enough.
76+
77+
- Often pull requests resolve one or more other issues (or pull requests).
78+
If merging your pull request means that some other issues/PRs should
79+
be closed, you should
80+
[use keywords to create link to them](https://github.com/blog/1506-closing-issues-via-pull-requests/)
81+
(e.g., `Fixes #1234`; multiple issues/PRs are allowed as long as each one
82+
is preceded by a keyword). Upon merging, those issues/PRs will
83+
automatically be closed by GitHub. If your pull request is simply related
84+
to some other issues/PRs, create a link to them without using the keywords
85+
(e.g., `See also #1234`).
7686

7787
- All public methods should have informative docstrings with sample
7888
usage presented as doctests when appropriate.

PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
<!--
22
Thanks for contributing a pull request! Please ensure you have taken a look at
3-
the contribution guidelines: https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md#Contributing-Pull-Requests
3+
the contribution guidelines: https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md#pull-request-checklist
4+
-->
5+
6+
#### Reference Issues/PRs
7+
<!--
8+
Example: Fixes #1234. See also #3456.
9+
Please use keywords (e.g., Fixes) to create link to the issues or pull requests
10+
you resolved, so that they will automatically be closed when your pull request
11+
is merged. See https://github.com/blog/1506-closing-issues-via-pull-requests
412
-->
5-
#### Reference Issue
6-
<!-- Example: Fixes #1234 -->
713

814

915
#### What does this implement/fix? Explain your changes.

doc/developers/contributing.rst

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,10 +218,20 @@ rules before submitting a pull request:
218218
``sklearn.utils`` submodule. A list of utility routines available
219219
for developers can be found in the :ref:`developers-utils` page.
220220

221-
* If your pull request addresses an issue, please use the title to describe
222-
the issue and mention the issue number in the pull request description to
223-
ensure a link is created to the original issue.
224-
221+
* Give your pull request a helpful title that summarises what your
222+
contribution does. In some cases "Fix <ISSUE TITLE>" is enough.
223+
"Fix #<ISSUE NUMBER>" is not enough.
224+
225+
* Often pull requests resolve one or more other issues (or pull requests).
226+
If merging your pull request means that some other issues/PRs should
227+
be closed, you should `use keywords to create link to them
228+
<https://github.com/blog/1506-closing-issues-via-pull-requests/>`_
229+
(e.g., ``Fixes #1234``; multiple issues/PRs are allowed as long as each
230+
one is preceded by a keyword). Upon merging, those issues/PRs will
231+
automatically be closed by GitHub. If your pull request is simply
232+
related to some other issues/PRs, create a link to them without using
233+
the keywords (e.g., ``See also #1234``).
234+
225235
* All public methods should have informative docstrings with sample
226236
usage presented as doctests when appropriate.
227237

0 commit comments

Comments
 (0)
0