We're so excited you're here and would like to contribute. We welcome contributions of any size and from any skill level, and would love to hear from you - opening issues and submitting pull requests are highly encouraged!
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. We value reproducible, open science, and highly recommend The Turing Way as a resource if you have questions along the way or would like to explore this area.
Most of the writing that you'll do will be in [Markdown][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://www.youtube.com/watch?v=dQw4w9WgXcQ)
) to another webpage.
When writing in Markdown, please start each new sentence on a new line.
While this formats in the same way as if the new line wasn't included, it makes the diffs produced during the pull request review easier to read! ✨
GitHub has a helpful page on getting started with writing and formatting on GitHub as well.
Looking forward to hearing from you! Thanks for helping us build this useful resource 😄