Thank you for thinking about contributing to the Brains For Publication 2016 OHBM Hackathon project!
At time of writing (4th April 2016) this page is still under construction, but it will grow into some guidelines on how to contribute to the project. It was created by Kirstie but all edits are very welcome!
It complements the README file which gives more information about the goals of the project.
If you have some code that makes pretty brain pictures please upload it into the NotYetCurated folder. Please upload all the comments and documentation that you have, but don't worry if it's just a snippet at the moment! One of the goals for the hackathon is to work on making all our individual hard work easy to access by others.
Once your code is in the folder, you could open an issue to describe what it does and suggest any work that could be done to make it even better.
Although GitHub calls them issues, I like to think of them as conversation starters. You can use them for anything, asking questions, sharing links to suggestions, starting work plans, whatever you fancy! They're a great tool to allow us to work collaboratively and get feedback on our ideas.
Remember that we all love to receive positive feedback, so please be liberal with your reactions to any suggestions. 👍 😄 ❤️ 🎉
If you'd like to contribute documentation or code to the project you can open a pull request.
Before you put lots of work into your code, it's a good idea to open an issue describing the work you're planning to contribute to make sure we aren't reinventing the wheel or duplicating work that is already underway. This is a lovely blog post that explains how everyone benefits from this upfront work.
If you need any help submiting a pull request you can ask Kirstie on Slack, in a GitHub issue (@KirstieJane), on twitter or by email (kw401 AT cam DOT ac DOT uk). She's happy to help and really passionate about making everyone in the team feel comfortable irregardless of their prior GitHub expertise!
Everyone's work is important, whether you provide feedback on an issue by giving it a little 👍, you suggest refinements to some documentation, you comment someone elses code, or make it generalisable to your use, the project is stronger when we have a range of people helping out.
We have a Let's Build a Hat Rack page that shows everyone who has contributed to the project. You can find out more about Let's Build a Hat Rack at their home page.