@@ -111,9 +111,34 @@ 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 ] .
@@ -122,7 +147,7 @@ using an [fMRIPrep development environment][link_devel].
122
147
Once you are satisfied with your local changes, [ add/commit/push them] [ link_add_commit_push ]
123
148
to the branch on your forked repository.
124
149
125
- ** 4 . Submit a [ pull request] [ link_pullrequest ] .**
150
+ ** 5 . Submit a [ pull request] [ link_pullrequest ] .**
126
151
127
152
A member of the development team will review your changes to confirm
128
153
that they can be merged into the main code base.
@@ -233,6 +258,11 @@ You're awesome. :wave::smiley:
233
258
234
259
[link_pullrequest]:https:// help .github.com/ en/ articles/ creating- a- pull- request- from - a- fork
235
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
236
266
[link_pushpullblog]: https:// www.igvita.com/ 2011 / 12 / 19 / dont- push- your- pull- requests/
237
267
[link_branches]: https:// help .github.com/ articles/ creating- and - deleting- branches- within- your- repository/
238
268
[link_add_commit_push]: https:// help .github.com/ en/ articles/ adding- a- file - to- a- repository- using- the- command- line
0 commit comments