@@ -111,30 +111,57 @@ is so useful to everyone involved.
111
111
This is now your own unique copy of `` fMRIPrep `` .
112
112
Changes here won't effect anyone else's work, so it's a safe space to explore edits to the code!
113
113
114
- Make sure to [ keep your fork up to date ] [ link_updateupstreamwiki ] with the master repository.
114
+ ** 3. [ Clone ] [ link_clone ] your forked fMRIPrep repository to your machine/computer **
115
115
116
- ** 3. Make the changes you've discussed, following the [ fMRIPrep coding style guide] ( #fMRIPrep-coding-style-guide ) .**
116
+ While you can edit files [ directly on github] [ link_githubedit ] , sometimes the changes
117
+ you want to make will be complex and you will want to use a [ text editor] [ link_texteditor ]
118
+ that you have installed on your local machine/computer.
119
+ (One great text editor is [ vscode] [ link_vscode ] ).
120
+
121
+ In order to work on the code locally, you must clone your forked repository.
122
+
123
+ To keep up with changes in the fmriprep repository,
124
+ add the [ "upstream" fmriprep repository as a remote] [ link_addremote ]
125
+ to your locally cloned repository.
126
+
127
+ ``` Shell
128
+ git remote add upstream https://github.com/poldracklab/fmriprep.git
129
+ ```
130
+
131
+ Make sure to [ keep your fork up to date] [ link_updateupstreamwiki ] with the upstream repository.
132
+
133
+ For example, to update your master branch on your local cloned repository:
134
+
135
+ ``` Shell
136
+ git fetch upstream
137
+ git checkout master
138
+ git merge upstream/master
139
+ ```
140
+
141
+ ** 4. Make the changes you've discussed, following the [ fMRIPrep coding style guide] ( #fMRIPrep-coding-style-guide ) .**
117
142
118
143
Try to keep the changes focused.
119
144
If you feel tempted to "branch out" then please make a [ new branch] [ link_branches ] .
120
145
It can also be helpful to test your changes locally,
121
146
using an [ fMRIPrep development environment] [ link_devel ] .
147
+ Once you are satisfied with your local changes, [ add/commit/push them] [ link_add_commit_push ]
148
+ to the branch on your forked repository.
122
149
123
- ** 4 . Submit a [ pull request] [ link_pullrequest ] .**
150
+ ** 5 . Submit a [ pull request] [ link_pullrequest ] .**
124
151
125
152
A member of the development team will review your changes to confirm
126
153
that they can be merged into the main code base.
127
154
128
155
Pull requests titles should begin with a descriptive prefix:
129
156
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
157
+ * `` ENH `` : enhancements or new features ( [ example ] [ enh_ex ] )
158
+ * `` FIX `` : bug fixes ( [ example ] [ fix_ex ] )
159
+ * `` TST `` : new or updated tests ( [ example ] [ tst_ex ] )
160
+ * `` DOC `` : new or updated documentation ( [ example ] [ doc_ex ] )
161
+ * `` STY `` : style changes ( [ example ] [ sty_ex ] )
162
+ * `` REF `` : refactoring existing code ( [ example ] [ ref_ex ] )
163
+ * `` CI `` : updates to continous integration infrastructure ( [ example ] [ ci_ex ] )
164
+ * `` MAINT `` : general maintenance ( [ example ] [ maint_ex ] )
138
165
139
166
For example: ` [ENH] Support for SB-reference in multi-band datasets `
140
167
@@ -229,11 +256,26 @@ You're awesome. :wave::smiley:
229
256
[link_helpwanted]: https:// github.com/ poldracklab/ fmriprep/ labels/ help % 20wanted
230
257
[link_feature]: https:// github.com/ poldracklab/ fmriprep/ labels/ feature
231
258
232
- [link_pullrequest]: https:// help .github.com/ articles/ creating- a- pull- request/
259
+ [link_pullrequest]: https:// help .github.com/ articles/ creating- a- pull- request- from - a - fork
233
260
[link_fork]: https:// help .github.com/ articles/ fork- a- repo/
261
+ [link_clone]: https:// help .github.com/ articles/ cloning- a- repository
262
+ [link_githubedit]: https:// help .github.com/ articles/ editing- files- in - your- repository
263
+ [link_texteditor]: https:// en.wikipedia.org/ wiki/ Text_editor
264
+ [link_vscode]: https:// code.visualstudio.com/
265
+ [link_addremote]: https:// help .github.com/ articles/ configuring- a- remote- for - a- fork
234
266
[link_pushpullblog]: https:// www.igvita.com/ 2011 / 12 / 19 / dont- push- your- pull- requests/
235
267
[link_branches]: https:// help .github.com/ articles/ creating- and - deleting- branches- within- your- repository/
268
+ [link_add_commit_push]: https:// help .github.com/ articles/ adding- a- file - to- a- repository- using- the- command- line
236
269
[link_updateupstreamwiki]: https:// help .github.com/ articles/ syncing- a- fork/
237
270
[link_stemmrolemodels]: https:// github.com/ KirstieJane/ STEMMRoleModels
238
271
[link_zenodo]: https:// github.com/ poldracklab/ fmriprep/ blob/ master/ .zenodo.json
239
272
[link_devel]: https:// fmriprep.readthedocs.io/ en/ latest/ contributors.html
273
+
274
+ [enh_ex]: https:// github.com/ poldracklab/ fmriprep/ pull/ 1508
275
+ [fix_ex]: https:// github.com/ poldracklab/ fmriprep/ pull/ 1378
276
+ [tst_ex]: https:// github.com/ poldracklab/ fmriprep/ pull/ 1098
277
+ [doc_ex]: https:// github.com/ poldracklab/ fmriprep/ pull/ 1515
278
+ [sty_ex]: https:// github.com/ poldracklab/ fmriprep/ pull/ 675
279
+ [ref_ex]: https:// github.com/ poldracklab/ fmriprep/ pull/ 816
280
+ [ci_ex]: https:// github.com/ poldracklab/ fmriprep/ pull/ 1048
281
+ [maint_ex]: https:// github.com/ poldracklab/ fmriprep/ pull/ 1239
0 commit comments