Thank you for your interest in contributing to HBAsets! 😃🎉
HBAsets is a project that aims to reuse open brain transcriptome data to facilitate polygenic analyses and create molecular brain maps.
This documents is a set of guidelines for contributing to HBAsets on GitHub. These are guidelines, not rules. This guide is meant to make it easy for you to get involved.
If your guide is long, consider adding a table of contents.
This project adheres to a code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to derek.howard(at)camh.ca.
Check out this Roadmap to get a better idea of the direction this project is taking.
The project is comprised of 3 main parts:
- data processing to transform the wide variety of open transcriptome data into reference datasets
- analysis to determine the brain areas which co-express the genes of interest
- an application to allow a user to provide gene lists as input and to interact with the results of the analysis
We need many different skills to help build this tool, and you can help! Take a look at the issues that have been raised and keep an eye out for issues with labels of interest.
Once you've identified one of the issues above that you feel you can contribute to, you're ready to make a change to the project repository!
- First, describe what you're planning to do as a comment to the issue, (and this might mean making a new issue). It's a good idea to check in with others to ensure you don't work on something that overlaps with work that is already under way.
- Fork the HBAsets repository. This makes your own version of this project you can edit and use.
- Make your changes! You can do this in the GitHub interface on your own local machine. Once you're happy with your changes...
- Submit a pull request. This opens a discussion around your project and lets the project lead know you are proposing changes.
First time contributing to open source? Check out this free series, How to Contribute to an Open Source Project on GitHub.