diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..06f51159 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing to Taxonium + +We're delighted that you're interested in contributing to Taxonium! This document is intended to outline the process for contributing to the Taxonium project and explain how you can get involved. + +## Code of Conduct + +Before contributing, please read the [Code of Conduct](https://github.com/theosanderson/genomium/blob/main/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms. + +## How to Contribute + +### Reporting Bugs + +If you encounter a bug in Taxonium, please open an issue in our GitHub repository. Include a clear description of the problem and, if possible, steps to reproduce it. You can paste images (e.g. screenshots) into the comment and they will be uploaded. + +### Suggesting Enhancements + +Have ideas on how to make Taxonium better? Open an issue and tag it as a feature request. Please provide a clear and detailed explanation of what you would like to see added or changed. + +### Contributing Code + +We welcome suggestions for code changes, either to fix bugs, improve performance, or add new functionality. If adding new functionality you are very welcome to reach out in advance of writing your code to check whether it is inline with our development roadmap. + +### Working with Issues + +Feel free to take on open issues. Before you start, check if anyone else has claimed that issue and communicate your intention to work on it. + +## Development Setup + +For information on setting up your development environment for Taxonium, refer to our [development documentation](./DEVELOPMENT.md). + +## Asking Questions + +Have a question? Open an issue with your question to get help from the maintainers and other contributors, or start a discussion. + +## Thank You + +Your contributions to Taxonium are greatly appreciated!