Skip to content

Commit c20844a

Browse files
authored
Add pull request template (nilearn#2455)
* Add pull request template. * Fix miscellaneous typos and formatting in AUTHORS.rst. The key typos are listed below, but fixing those typos required changing whole paragraphs to maintain line-length limits: - Mehdi Rahim, Philippe Gervais **where payed** by the - I’m not sure if this should be past tense, but I kept it that way just in case. - A huge amount of work goes **in the scikit-learn**.
1 parent f4d6607 commit c20844a

File tree

2 files changed

+36
-11
lines changed

2 files changed

+36
-11
lines changed

.github/pull_request_template.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!---
2+
This is a suggested pull request template for nilearn.
3+
It's designed to capture information we've found to be useful in reviewing pull requests.
4+
5+
If there is other information that would be helpful to include, please don't hesitate to add it!
6+
7+
See here for more information on what is expected for pull requests:
8+
https://github.com/nilearn/nilearn/blob/master/CONTRIBUTING.rst#pull-requests
9+
-->
10+
11+
<!-- Please indicate after the # which issue you're closing with this PR.
12+
This is helpful for the maintainers AND will magically close the issue when this
13+
pull request is merged!
14+
If the PR closes multiple issues, includes "closes" before each one is listed.
15+
https://help.github.com/articles/closing-issues-using-keywords -->
16+
Closes # .
17+
18+
<!-- Please give a brief overview of what has changed in the PR.
19+
If you're not sure what to write, consider it a note to the maintainers to indicate
20+
what they should be looking for when they review the pull request. -->
21+
Changes proposed in this pull request:
22+
23+
-
24+
-

AUTHORS.rst

+12-11
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Additional credit goes to M. Hanke and Y. Halchenko for data and packaging.
1616
.. _core_devs:
1717

1818
Core developers
19-
.................
19+
...............
2020

2121
The nilearn core developers are:
2222

@@ -35,10 +35,10 @@ The nilearn core developers are:
3535
* Salma Bougacha https://github.com/salma1601
3636

3737
Funding
38-
........
38+
.......
3939

4040
Alexandre Abraham, Gael Varoquaux, Kamalakar Reddy Daddy, Loïc Estève,
41-
Mehdi Rahim, Philippe Gervais where payed by the `NiConnect
41+
Mehdi Rahim, Philippe Gervais were paid by the `NiConnect
4242
<https://team.inria.fr/parietal/18-2/spatial_patterns/niconnect>`_
4343
project, funded by the French `Investissement d'Avenir
4444
<http://www.gouvernement.fr/investissements-d-avenir-cgi>`_.
@@ -49,7 +49,7 @@ NiLearn is also supported by `DigiCosme <https://digicosme.lri.fr>`_
4949
.. _citing:
5050

5151
Citing nilearn
52-
------------------------
52+
--------------
5353

5454
There is no paper published yet about nilearn. We are waiting for the
5555
package to mature a bit. However, the patterns underlying the package
@@ -61,13 +61,14 @@ We suggest that you read and cite the paper. Thank you.
6161

6262

6363
Citing scikit-learn
64-
------------------------
65-
66-
A huge amount of work goes in the scikit-learn. Researchers that invest
67-
their time in developing and maintaining the package deserve recognition
68-
with citations. In addition, the Parietal team needs the citations to the
69-
paper in order to justify paying a software engineer on the project. To
70-
guarantee the future of the toolkit, if you use it, please cite it.
64+
-------------------
65+
66+
A huge amount of work goes into scikit-learn, upon which nilearn relies heavily.
67+
Researchers who invest their time in developing and maintaining the package
68+
deserve recognition with citations.
69+
In addition, the Parietal team needs citations to the paper in order to
70+
justify paying a software engineer on the project.
71+
To guarantee the future of the toolkit, if you use it, please cite it.
7172

7273
See the scikit-learn documentation on `how to cite
7374
<http://scikit-learn.org/stable/about.html#citing-scikit-learn>`_.

0 commit comments

Comments
 (0)