Skip to content

[MRG] DOC Encourage contributors to use keywords to close issue automatically #9954

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Oct 20, 2017
Merged

[MRG] DOC Encourage contributors to use keywords to close issue automatically #9954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
90a4ecf
guide to close issue
qinhanmin2014 Oct 19, 2017
d7880d7
update pull request template
qinhanmin2014 Oct 19, 2017
3f924f3
address comment
qinhanmin2014 Oct 19, 2017
acc1325
improve
qinhanmin2014 Oct 19, 2017
f687433
typo
qinhanmin2014 Oct 19, 2017
c252908
minor improve
qinhanmin2014 Oct 19, 2017
77f53a4
update
qinhanmin2014 Oct 19, 2017
e5a9183
copy paste of my part (how about the rest?)
qinhanmin2014 Oct 19, 2017
56e122c
personal suggestion
qinhanmin2014 Oct 19, 2017
02cb052
minor improve
qinhanmin2014 Oct 19, 2017
4a95927
address comment
qinhanmin2014 Oct 19, 2017
e49dff3
address comment
qinhanmin2014 Oct 19, 2017
a0e52a8
minor fix
qinhanmin2014 Oct 19, 2017
b7151fb
minor improve
qinhanmin2014 Oct 19, 2017
2b43fca
Merge remote-tracking branch 'upstream/master' into close-issue-guide
qinhanmin2014 Oct 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,19 @@ following rules before you submit a pull request:
[Utilities for Developers](http://scikit-learn.org/dev/developers/utilities.html#developers-utils)
page.

- If your pull request addresses an issue, please use the pull request title
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
created.
- Give your pull request a helpful title that summarises what your
contribution does. In some cases `Fix <ISSUE TITLE>` is enough.
`Fix #<ISSUE NUMBER>` is not enough.

- Often pull requests resolve one or more other issues (or pull requests).
If merging your pull request means that some other issues/PRs should
be closed, you should
[use keywords to create link to them](https://github.com/blog/1506-closing-issues-via-pull-requests/)
(e.g., `Fixes #1234`; multiple issues/PRs are allowed as long as each one
is preceded by a keyword). Upon merging, those issues/PRs will
automatically be closed by GitHub. If your pull request is simply related
to some other issues/PRs, create a link to them without using the keywords
(e.g., `See also #1234`).

- All public methods should have informative docstrings with sample
usage presented as doctests when appropriate.
Expand Down
12 changes: 9 additions & 3 deletions PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
<!--
Thanks for contributing a pull request! Please ensure you have taken a look at
the contribution guidelines: https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md#Contributing-Pull-Requests
the contribution guidelines: https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md#pull-request-checklist
-->

#### Reference Issues/PRs
<!--
Example: Fixes #1234. See also #3456.
Please use keywords (e.g., Fixes) to create link to the issues or pull requests
you resolved, so that they will automatically be closed when your pull request
is merged. See https://github.com/blog/1506-closing-issues-via-pull-requests
-->
#### Reference Issue
<!-- Example: Fixes #1234 -->


#### What does this implement/fix? Explain your changes.
Expand Down
18 changes: 14 additions & 4 deletions doc/developers/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,10 +218,20 @@ rules before submitting a pull request:
``sklearn.utils`` submodule. A list of utility routines available
for developers can be found in the :ref:`developers-utils` page.

* If your pull request addresses an issue, please use the title to describe
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leave in:

* Give your pull request a helpful title that summarises what your contribution does. In some cases "Fix <ISSUE TITLE>" is enough. "Fix #<ISSUE NUMBER>" is not enough.

the issue and mention the issue number in the pull request description to
ensure a link is created to the original issue.

* Give your pull request a helpful title that summarises what your
contribution does. In some cases "Fix <ISSUE TITLE>" is enough.
"Fix #<ISSUE NUMBER>" is not enough.

* Often pull requests resolve one or more other issues (or pull requests).
If merging your pull request means that some other issues/PRs should
be closed, you should `use keywords to create link to them
<https://github.com/blog/1506-closing-issues-via-pull-requests/>`_
(e.g., ``Fixes #1234``; multiple issues/PRs are allowed as long as each
one is preceded by a keyword). Upon merging, those issues/PRs will
automatically be closed by GitHub. If your pull request is simply
related to some other issues/PRs, create a link to them without using
the keywords (e.g., ``See also #1234``).

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

Expand Down