You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-13Lines changed: 16 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,10 @@ Welcome to the Nipype repository! We're excited you're here and want to contribu
4
4
5
5
These guidelines are designed to make it as easy as possible to get involved. If you have any questions that aren't discussed below, please let us know by opening an [issue][link_issues]!
6
6
7
-
Before you start you'll need to set up a free [GitHub][link_github] account and sign in, here are some [instructions][link_signupinstructions].
8
-
If you are not familiar with version control system and Git,
9
-
you will find introduction and links to tutorials [here](http://www.reproducibleimaging.org/module-reproducible-basics/02-vcs/).
7
+
Before you start you'll need to set up a free [GitHub][link_github] account and sign in. Here are some [instructions][link_signupinstructions].
8
+
If you are not familiar with version control systems such as git,
9
+
[introductions and tutorials](http://www.reproducibleimaging.org/module-reproducible-basics/02-vcs/)
10
+
may be found on [ReproducibleImaging.org](https://www.reproducibleimaging.org/).
10
11
11
12
Already know what you're looking for in this guide? Jump to the following sections:
12
13
*[Understanding issue labels](#issue-labels)
@@ -49,26 +50,28 @@ This allows other members of the Nipype development team to confirm that you are
49
50
50
51
**2. [Fork][link_fork] the [Nipype repository][link_nipype] to your profile.**
51
52
52
-
This is now your own unique copy of Nipype repository.
53
+
This is now your own unique copy of the Nipype repository.
53
54
Changes here won't affect anyone else's work, so it's a safe space to explore edits to the code!
54
55
55
56
You can clone your Nipype repository in order to create a local copy of the code on your machine.
56
-
In your local Nipype directory, run `pip install -e .[dev]`.
57
-
This will add your version of nipype to your local python environment and
58
-
install dependencies needed for development.
57
+
To install your version of Nipype, and the dependencies needed for development,
58
+
in your Python environment, run `pip install -e ".[dev]"` from your local Nipype
59
+
directory.
59
60
60
-
Make sure to [keep your fork up to date][link_updateupstreamwiki] with the original Nipype repository.
61
+
Make sure to keep your fork up to date with the original Nipype repository.
62
+
One way to do this is to [configure a new remote named "upstream"](https://help.github.com/articles/configuring-a-remote-for-a-fork/)
63
+
and to [sync your fork with the upstream repository][link_updateupstreamwiki].
61
64
62
65
**3. Make the changes you've discussed.**
63
66
64
67
If you're adding a new tool from an existing neuroimaging toolkit (e.g., 3dDeconvolve from AFNI),
65
68
check out the [guide for adding new interfaces to Nipype][link_new_interfaces].
66
69
67
-
When you are working on your changes, you should test frequently if you are not breaking the existing code,
68
-
more on testing you will find [the testing section of Nipype documentation](http://nipype.readthedocs.io/en/latest/devel/testing_nipype.html).
70
+
When you are working on your changes, test frequently to ensure you are not breaking the existing code.
71
+
For more on testing, please see [the testing section of Nipype documentation](http://nipype.readthedocs.io/en/latest/devel/testing_nipype.html).
69
72
70
-
Before pushing your changes to GitHub run `make check-before-commit`, this will remove trailing spaces, create new auto tests,
71
-
test entire package and build the documentation.
73
+
Before pushing your changes to GitHub, run `make check-before-commit`. This will remove trailing spaces, create new auto tests,
74
+
test the entire package, and build the documentation.
72
75
If you get no errors, you're ready to submit your changes!
73
76
74
77
It's a good practice to create [a new branch](https://help.github.com/articles/about-branches/)
@@ -95,7 +98,7 @@ If your pull request is not yet ready to be merged, please also include the **[W
95
98
This tells the development team that your pull request is a "work-in-progress", and that you plan to continue working on it.
96
99
97
100
Review and discussion on new code can begin well before the work is complete, and the more discussion the better!
98
-
This provides the opportunity to check with the development team the path you've outlined.
101
+
The development team may prefer a different path than you've outlined, so it's better to discuss it and get approval at the early stage of your work.
99
102
100
103
One your PR is ready a member of the development team will review your changes to confirm that they can be merged into the main codebase.
0 commit comments