Link Search Menu Expand Document

Contributing

How to contribute to this repository


We want to ensure that every user and contributor feels welcome and included in the WIN Open Neuroimaging community. We ask all contributors and community members to follow the code of conduct in all community interactions.

We hope that this guideline document will make it as easy as possible for you to get involved.

Please follow these guidelines to make sure your contributions can be easily integrated in the projects. As you start contributing to the WIN Open Neuroimaging, don’t forget that your ideas are more important than perfect pull requests.

1. Contact us

In the first instance, we encourage you connect with the Open WIN Community. Let us know that you are reading the repository and you would like to contribute! You might like to introduce yourself on the #welcome channel on our Slack workspace! 👋

2. Check what we’re working on

We also invite you to review our roadmap and see how we are progressing against our community milestones.

3. Join us at a documentation hack!

We will be holding regular “documentation hacks”, where you will be guided through the process of contributing to the repository, and can participate in a git tutorial if you’d benefit from this. Take a look at our events page to find out when the next documentation hack will be held.

At the documentation hack, you will hear from members of the Open Neuroimaging Project Working Groups and learn about the progress of each tool. You will learn how to use each tool, be invited to contribute feedback to the tool developers, and invited to write “how to” guides to walk novice users through the process of shearing their research outputs using the Open WIN Tools.

We will also use the documentation hacks to plan as a community, learn about what policy or guidance we need to support working open at WIN, and think about how we would like to develop. This will include community-led planning of the Open WIN Ambassadors scheme.

Or, 4. Jump straight in!

If you are confident using git, markdown, and github pages, you are very welcome to submit an issue to our github repository, and submit a pull request.

Coming soon

We will add git and contribution training materials after our first documentation hack, to be held in October 2020