How to Start Contributing
There are many valuable ways to contribute besides writing code. Thank you for dedicating your time to improve our projects!
Bug reports and enhancement requests
Bug reports and enhancement requests are an important part of making any software more stable. We curate them though Github issues. When opening an issue or request, please select the appropriate category and fill out the issue form fully to ensure others and the core development team can fully understand the scope of the issue. If your category is not listed, you can create a blank issue.
The issue will then show up to the BioCypher community and be open to comments/ideas from others.
Categories
- Bug Report: Report incorrect behavior in one of the BioCypher ecosystem libraries (BioCypher, BioChatter)
- Register New Component: Register a new component in the BioCypher ecosystem, either one you have created, or one that you would like to see added
- Add New BioChatter Model: Request to add a new model to the benchmark
- Documentation Improvement: Report wrong or missing documentation
- Feature Request: Suggest an idea for BioCypher
Detailed Guides
-
Contributing to the Documentation
A simple way to get started is to contribute to the documentation. Please follow the guide here to learn how to do so.
-
Contributing to the Code Base
The best way to contribute code is to open a pull request on Github. Please follow the guide here to learn how to do so.