Skip to content

Commit b4a7eae

Browse files
authored
Update pull_request_template.md
1 parent e57711c commit b4a7eae

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

docs/pull_request_template.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
1-
Please make sure you have read the PR guidelines below, and checked all boxes that apply at the bottom.
2-
31
## Changes proposed in this pull request
42

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 #``).
3+
<!--
4+
Please describe here the main features / changes proposed for review and integration in fMRIPrep
5+
If this PR addresses some existing problem, please use GitHub's citing tools
6+
(eg. ref #, closes # or fixes #).
87
If there is not an existing issue open describing the problem, please consider opening a new
9-
issue first and then link it from here (so the *fMRIPrep* has a better understanding of ongoing development
10-
efforts and possible overlaps between contributions).
8+
issue first and then link it from here (so the *fMRIPrep* community has a better understanding
9+
of ongoing development efforts and possible overlaps between contributions).
10+
-->
1111

1212

1313
## Documentation that should be reviewed
14-
15-
Please summarize the main changes to the documentation that the reviewers should be aware of.
14+
<!--
15+
Please summarize here the main changes to the documentation that the reviewers should be aware of.
16+
-->
1617

1718
## Pull-request guidelines:
18-
19+
<!--
20+
Please make sure you have read the PR guidelines below, and checked
21+
all boxes that apply at the bottom.
22+
-->
1923
1. We invite you to list yourself as a *fMRIPrep* contributor, so if your name
2024
is not already mentioned, please modify the
2125
[``.zenodo.json``](https://github.com/poldracklab/fmriprep/blob/master/.zenodo.json)
@@ -36,21 +40,23 @@ Please summarize the main changes to the documentation that the reviewers should
3640
2. By submitting this request you acknowledge that your contributions are available under the BSD 3-Clause license.
3741

3842
3. Use a descriptive prefix, between brackets for your PR: ``ENH`` (enhancement), ``FIX``, ``TST``, ``DOC``, ``STY``,
39-
``REF`` (refactor), ``WIP`` (Work in progress), ``MAINT`` (maintenance). Example:
43+
``REF`` (refactor), ``CI`` (continous integration), ``MAINT`` (maintenance). Example:
4044
```
4145
[ENH] Support for SB-reference in multi-band datasets
4246
```
47+
For works-in-progress, add the ``WIP`` tag in addition to the descriptive prefix.
4348
Pull-requests tagged with ``[WIP]`` will not merged in until the tag is removed.
4449

45-
4. Your PR will be reviewed following the following
50+
4. Your PR will be reviewed according to the following
4651
[template](https://github.com/poldracklab/fmriprep/wiki/Reviewing-a-Pull-Request).
4752

4853
5. Documentation is a fundamental aspect to the *glass-box* philosophy that *fMRIPrep* abides by.
4954
Please understand that the *fMRIPrep* team may (are likely to) request you to improve the documentation
5055
provided with this PR, within the PR or in future PRs.
5156

5257

53-
**Please check what corresponds**:
58+
**Please review and check the following**:
59+
<!-- replace the empty checkboxes [ ] below with checked ones [x] accordingly -->
5460

5561
- [ ] I have read the [guidelines for contributions](https://github.com/poldracklab/fmriprep/blob/master/CONTRIBUTING.md).
5662
- [ ] I understand that my contributions will not be merged unless the work is

0 commit comments

Comments
 (0)