The point of our tutorial is to help you visualise your data that is both beautiful and statistically valid. We hope that the preprint and the tutorials in this repository will make that as easy as possible.
Been here before? Already know what you're looking for in this guide? Jump to the following sections:
- Contributing through GitHub
- Where to start: wiki, code and templates
- Where to start: issue labels
- Make a change with a pull request
- Recognizing contributions
git is a really useful tool for version control. GitHub sits on top of git and supports collaborative and distributed working.
We know that it can be daunting to start using git and GitHub if you haven't worked with them in the past, but Kirstie is here to help you figure out any of the jargon or confusing instructions you encounter! ❤️
In order to contribute via GitHub you'll need to set up a free account and sign in. Here are some instructions to help you get going. Remember that you can ask us any questions you need to along the way.
GitHub has a helpful page on getting started with writing and formatting on GitHub.
Most of the writing that you'll do will be in Markdown. You can think of Markdown as a few little symbols around your text that will allow GitHub to render the text with a little bit of formatting. For example you could write words as bold (**bold**), or in italics (*italics*), or as a link ([link](https://https://youtu.be/dQw4w9WgXcQ)) to another webpage.
We appreciate all contributions to the RainCloudPlots codebase and tutorials. THANK YOU for helping us build this useful resource. ✨🌟💫
The following steps are a guide to help you contribute in a way that will be easy for everyone to review and accept with ease 😎.
This allows other members of the RainCloud Plots 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.
This blog is a nice explanation of why putting this work in up front is so useful to everyone involved.
2. Fork the RainCloudPlots to your profile
This is now your own unique copy of the RainCloudPlots repository. Changes here won't affect anyone else's work, so it's a safe space to explore edits to the code!
Make sure to keep your fork up to date with the master repository, otherwise you can end up with lots of dreaded merge conflicts.
Try to keep the changes focused. If you submit a large amount of work in all in one go it will be much more work for whomever is reviewing your pull request. Help them help you 😉
If you feel tempted to "branch out" then please make a new branch and a new issue to go with it.
4. Submit a pull request
A member of the RainCloud Plots team will review your changes to confirm that they can be merged into the main codebase.
A review will probably consist of a few questions to help clarify the work you've done. Keep an eye on your github notifications and be prepared to join in that conversation.
You can update your fork of the BIDS Starter Kit repository and the pull request will automatically update with those changes. You don't need to submit a new pull request when you make a change in response to a review.
GitHub has a nice introduction to the pull request workflow, but please get in touch if you have any questions 🎈.
You're awesome. 👋😃
— Based on contributing guidelines from the BIDS Starter Kit.