Skip to content

Commit fba9aa4

Browse files
authored
Create pull_request_template.md
1 parent bc97294 commit fba9aa4

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

docs/pull_request_template.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
Please make sure you have read the PR guidelines below, and checked all boxes that apply at the bottom.
2+
3+
## Changes proposed in this pull request
4+
5+
**Please describe here the main features / changes proposed for review and integration in fMRIPrep**
6+
7+
If this PR addresses some existing problem, please use GitHub's citing tools (eg. ``ref #``, ``closes #`` or ``fixes #``).
8+
9+
10+
11+
## Documentation that should be reviewed
12+
13+
Please summarize the main changes to the documentation that the reviewers should be aware of.
14+
15+
## Pull-request guidelines:
16+
17+
1. We invite you to list yourself as a *fMRIPrep* contributor, so if your name
18+
is not already mentioned, please modify the
19+
[``.zenodo.json``](https://github.com/poldracklab/fmriprep/blob/master/.zenodo.json)
20+
file with your data right above Russ' entry. Example:
21+
```
22+
{
23+
"name": "Contributor, New FMRIPrep",
24+
"affiliation": "Department of fMRI prep'ing, Open Science Made-Up University",
25+
"orcid": "<your id>"
26+
},
27+
{
28+
"name": "Poldrack, Russell A.",
29+
"affiliation": "Department of Psychology, Stanford University",
30+
"orcid": "0000-0001-6755-0259"
31+
},
32+
```
33+
34+
2. By submitting this request you acknowledge that your contributions are available under the BSD 3-Clause license.
35+
36+
3. Use a descriptive prefix, between brackets for your PR: ``ENH`` (enhancement), ``FIX``, ``TST``, ``DOC``, ``STY``,
37+
``REF`` (refactor), ``WIP`` (Work in progress), ``MAINT`` (maintenance). Example:
38+
```
39+
[ENH] Support for SB-reference in multi-band datasets
40+
```
41+
Pull-requests tagged with ``[WIP]`` will not merged in until the tag is removed.
42+
43+
4. Your PR will be reviewed following the following
44+
[template](https://github.com/poldracklab/fmriprep/wiki/Reviewing-a-Pull-Request).
45+
46+
5. Documentation is a fundamental aspect to the *glass-box* philosophy that *fMRIPrep* abides by.
47+
Please understand that the *fMRIPrep* team may (are likely to) request you to improve the documentation
48+
provided with this PR, within the PR or in future PRs.
49+
50+
51+
**Please check what corresponds**:
52+
53+
- [ ] I have read the [community rules for contributions](https://github.com/poldracklab/fmriprep/blob/master/CONTRIBUTING.md).
54+
- [ ] I understand that my contributions will not be merged unless the work is
55+
finished (i.e. no ``[WIP]`` tag remains in the title of my PR) and tests pass.
56+
- [ ] The proposed code follows the
57+
[coding guidelines](https://github.com/poldracklab/fmriprep/blob/master/CONTRIBUTING.md#fmriprep-coding-style-guide),
58+
to the extent I understood them (and I will address any comments raised by the PR's reviewers in this regard).
59+
- [ ] \(Optional\) I opt-out from being listed in the `.zenodo.json` file.

0 commit comments

Comments
 (0)