Skip to content

Commit 0932f31

Browse files
committed
make some clarifications and add more examples [skip ci]
1 parent 07ee316 commit 0932f31

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,8 @@ Try to keep the changes focused.
119119
If you feel tempted to "branch out" then please make a [new branch][link_branches].
120120
It can also be helpful to test your changes locally,
121121
using an [fMRIPrep development environment][link_devel].
122+
Once you are satisfied with your local changes, [add/commit/push them][link_add_commit_push]
123+
to the branch on your forked repository.
122124

123125
**4. Submit a [pull request][link_pullrequest].**
124126

@@ -127,14 +129,14 @@ that they can be merged into the main code base.
127129

128130
Pull requests titles should begin with a descriptive prefix:
129131

130-
* ``ENH``: enhancements or new features
131-
* ``FIX``: bug fixes
132-
* ``TST``: new or updated tests
133-
* ``DOC``: new or updated documentation
134-
* ``STY``: style changes
135-
* ``REF``: refactoring existing code
136-
* ``CI``: updates to continous integration infrastructure
137-
* ``MAINT``: general maintenance
132+
* ``ENH``: enhancements or new features ([example][enh_ex])
133+
* ``FIX``: bug fixes ([example][fix_ex])
134+
* ``TST``: new or updated tests ([example][tst_ex])
135+
* ``DOC``: new or updated documentation ([example][doc_ex])
136+
* ``STY``: style changes ([example][sty_ex])
137+
* ``REF``: refactoring existing code ([example][ref_ex])
138+
* ``CI``: updates to continous integration infrastructure ([example][ci_ex])
139+
* ``MAINT``: general maintenance ([example][maint_ex])
138140

139141
For example: `[ENH] Support for SB-reference in multi-band datasets`
140142

@@ -229,11 +231,21 @@ You're awesome. :wave::smiley:
229231
[link_helpwanted]: https://github.com/poldracklab/fmriprep/labels/help%20wanted
230232
[link_feature]: https://github.com/poldracklab/fmriprep/labels/feature
231233

232-
[link_pullrequest]: https://help.github.com/articles/creating-a-pull-request/
234+
[link_pullrequest]:https://help.github.com/en/articles/creating-a-pull-request-from-a-fork
233235
[link_fork]: https://help.github.com/articles/fork-a-repo/
234236
[link_pushpullblog]: https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/
235237
[link_branches]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
238+
[link_add_commit_push]: https://help.github.com/en/articles/adding-a-file-to-a-repository-using-the-command-line
236239
[link_updateupstreamwiki]: https://help.github.com/articles/syncing-a-fork/
237240
[link_stemmrolemodels]: https://github.com/KirstieJane/STEMMRoleModels
238241
[link_zenodo]: https://github.com/poldracklab/fmriprep/blob/master/.zenodo.json
239242
[link_devel]: https://fmriprep.readthedocs.io/en/latest/contributors.html
243+
244+
[enh_ex]: https://github.com/poldracklab/fmriprep/pull/1508
245+
[fix_ex]: https://github.com/poldracklab/fmriprep/pull/1378
246+
[tst_ex]: https://github.com/poldracklab/fmriprep/pull/1098
247+
[doc_ex]: https://github.com/poldracklab/fmriprep/pull/1515
248+
[sty_ex]: https://github.com/poldracklab/fmriprep/pull/675
249+
[ref_ex]: https://github.com/poldracklab/fmriprep/pull/816
250+
[ci_ex]: https://github.com/poldracklab/fmriprep/pull/1048
251+
[maint_ex]: https://github.com/poldracklab/fmriprep/pull/1239

0 commit comments

Comments
 (0)