File tree Expand file tree Collapse file tree 3 files changed +36
-10
lines changed Expand file tree Collapse file tree 3 files changed +36
-10
lines changed Original file line number Diff line number Diff line change @@ -70,9 +70,19 @@ following rules before you submit a pull request:
70
70
[ Utilities for Developers] ( http://scikit-learn.org/dev/developers/utilities.html#developers-utils )
71
71
page.
72
72
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 ` ).
76
86
77
87
- All public methods should have informative docstrings with sample
78
88
usage presented as doctests when appropriate.
Original file line number Diff line number Diff line change 1
1
<!--
2
2
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
4
12
-->
5
- #### Reference Issue
6
- <!-- Example: Fixes #1234 -->
7
13
8
14
9
15
#### What does this implement/fix? Explain your changes.
Original file line number Diff line number Diff line change @@ -218,10 +218,20 @@ rules before submitting a pull request:
218
218
``sklearn.utils `` submodule. A list of utility routines available
219
219
for developers can be found in the :ref: `developers-utils ` page.
220
220
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
+
225
235
* All public methods should have informative docstrings with sample
226
236
usage presented as doctests when appropriate.
227
237
You can’t perform that action at this time.
0 commit comments