Skip to content

Commit 10df36e

Browse files
committed
STY: Bullet list of prefixes
1 parent a2aff2b commit 10df36e

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,21 @@ It can also be helpful to test your changes locally, using an [FMRIPREP developm
5454

5555
A member of the development team will review your changes to confirm that they can be merged into the main codebase.
5656

57-
Pull requests titles should begin with a descriptive prefix: ``ENH`` (enhancement), ``FIX`` (bug fix), ``TST`` (testing),
58-
``DOC`` (documentation), ``STY`` (style), ``REF`` (refactor), ``CI`` (continous integration), ``MAINT`` (maintenance).
59-
For example, `[ENH] Support for SB-reference in multi-band datasets`.
57+
Pull requests titles should begin with a descriptive prefix:
58+
59+
* ``ENH``: enhancements or new features
60+
* ``FIX``: bug fixes
61+
* ``TST``: new or updated tests
62+
* ``DOC``: new or updated documentation
63+
* ``STY``: style changes
64+
* ``REF``: refactoring existing code
65+
* ``CI``: updates to continous integration infrastructure
66+
* ``MAINT``: general maintenance
67+
68+
For example: `[ENH] Support for SB-reference in multi-band datasets`
69+
6070
For works-in-progress, add the ``WIP`` tag in addition to the descriptive prefix.
61-
Pull-requests tagged with ``[WIP]`` will not merged in until the tag is removed.
71+
Pull-requests tagged with ``[WIP]`` will not be merged until the tag is removed.
6272

6373
## FMRIPREP coding style guide
6474

0 commit comments

Comments
 (0)