Skip to content

Commit 38b9b6d

Browse files
authored
Create CONTRIBUTING.md
1 parent 22406e2 commit 38b9b6d

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

CONTRIBUTING.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Contributing to `nipype_tutorial`
2+
3+
Welcome to the `nipype_tutorial` repository! We're excited you're here and want to contribute.
4+
5+
These guidelines are designed to make it as easy as possible to get involved.
6+
If you have any questions that aren't discussed below, please let us know by opening an [issue][link_issues]!
7+
8+
Before you start you'll need to set up a free [GitHub][link_github] account and sign in.
9+
Here are some [instructions][link_signupinstructions] on how to do just that!
10+
11+
### Labels
12+
13+
The current list of labels are [here][link_labels] and include:
14+
15+
* [![Help Wanted](https://img.shields.io/badge/-help%20wanted-159818.svg)][link_helpwanted]
16+
*These issues contain a task that a member of the team has determined we need additional help with.*
17+
18+
If you feel that you can contribute to one of these issues, we especially encourage you to do so!
19+
20+
* [![Bug](https://img.shields.io/badge/-bug-fc2929.svg)][link_bugs]
21+
*These issues point to problems in the project.*
22+
23+
If you find new a bug, please give as much detail as possible in your issue, including steps to recreate the error.
24+
If you experience the same bug as one already listed, please add any additional information that you have as a comment.
25+
26+
* [![Enhancement](https://img.shields.io/badge/-enhancement-84b6eb.svg)][link_feature]
27+
*These issues are asking for enhancements to be added to the project.*
28+
29+
Please try to make sure that your requested feature is distinct from any others that have already been requested or implemented.
30+
If you find one that's similar but there are subtle differences please reference the other request in your issue.
31+
32+
## Making a change
33+
34+
We appreciate all contributions to `nipype_tutorial`, but those accepted fastest will follow a workflow similar to the following:
35+
36+
**1. Comment on an existing issue or open a new issue referencing your addition.**
37+
38+
This allows other members of the `nipype_tutorial` development team to confirm that you aren't overlapping with work that's currently underway and that everyone is on the same page with the goal of the work you're going to carry out.
39+
40+
[This blog][link_pushpullblog] is a nice explanation of why putting this work in up front is so useful to everyone involved.
41+
42+
**2. [Fork][link_fork] the [`nipype_tutorial` repository][link_nipype_tutorial] to your profile.**
43+
44+
This is now your own unique copy of `nipype_tutorial`.
45+
Changes here won't effect anyone else's work, so it's a safe space to explore edits to the code!
46+
47+
Make sure to [keep your fork up to date][link_updateupstreamwiki] with the original repository.
48+
49+
**3. Make the changes you've discussed.**
50+
51+
Try to keep the changes focused.
52+
If you feel tempted to "branch out" then please make a [new branch][link_branches].
53+
54+
**4. Submit a [pull request][link_pullrequest].**
55+
56+
A member of the development team will review your changes to confirm that they can be merged into the main codebase.
57+
58+
## Recognizing contributions
59+
60+
We welcome and recognize all contributions from documentation to testing to code development.
61+
You can see a list of our current contributors in the [contributors tab][link_contributors].
62+
63+
## Thank you!
64+
65+
You're awesome. :wave::smiley:
66+
67+
<br>
68+
69+
*&mdash; Based on contributing guidelines from the [STEMMRoleModels][link_stemmrolemodels] project.*
70+
71+
[link_github]: https://github.com/
72+
[link_nipype_tutorial]: https://github.com/rmarkello/nipype_tutorial
73+
[link_signupinstructions]: https://help.github.com/articles/signing-up-for-a-new-github-account
74+
[link_react]: https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments
75+
[link_issues]: https://github.com/rmarkello/nipype_tutorial/issues
76+
[link_labels]: https://github.com/rmarkello/nipype_tutorial/labels
77+
[link_discussingissues]: https://help.github.com/articles/discussing-projects-in-issues-and-pull-requests
78+
79+
[link_bugs]: https://github.com/rmarkello/nipype_tutorial/labels/bug
80+
[link_helpwanted]: https://github.com/rmarkello/nipype_tutorial/labels/help%20wanted
81+
[link_feature]: https://github.com/rmarkello/nipype_tutorial/labels/enhancement
82+
83+
[link_pullrequest]: https://help.github.com/articles/creating-a-pull-request/
84+
[link_fork]: https://help.github.com/articles/fork-a-repo/
85+
[link_pushpullblog]: https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/
86+
[link_branches]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
87+
[link_updateupstreamwiki]: https://help.github.com/articles/syncing-a-fork/
88+
[link_contributors]: https://github.com/rmarkello/nipype_tutorial/graphs/contributors
89+
[link_stemmrolemodels]: https://github.com/KirstieJane/STEMMRoleModels

0 commit comments

Comments
 (0)