We welcome contributions to barcode-constrained-phylogeny and are grateful for every pull request or issue opened.
This document is a guide for those who wish to contribute to the project. Please read it carefully and follow the
guidelines to help ensure your contributions are effective and efficiently handled.
barcode-constrained-phylogeny adheres to a code of conduct. By participating in this project, you are expected to
uphold this code. Please read and follow our Code of Conduct.
Before you begin:
- Ensure you have a GitHub account.
- Familiarize yourself with basic Git commands and our project's workflow.
- Read our README for an overview of the project.
- Check the issues for a list of proposed features (and known issues).
Before creating an issue, please do the following:
- Perform a search to see if the issue has already been reported.
- If the issue has not been reported, create a new issue.
- Be sure to include a title and clear description.
- Add as much relevant information as possible, including screenshots and code snippets.
- Fork the repository.
- Clone your fork to your local machine and create a new branch:
git checkout -b my-new-feature
- Make your changes, commit, and push them to your fork.
- Visit the repository and create a pull request.
- Fill in the pull request template with relevant details.
- Write clean, maintainable, and performant code.
- Follow the coding style and best practices of the project.
- Include tests for your changes, if applicable.
- Update documentation as necessary.
After you submit a pull request, the maintainer(s) of barcode-constrained-phylogeny will review your code. This
process might include discussion about the proposed changes. Be open to feedback and willing to make adjustments.
Thank you for contributing to barcode-constrained-phylogeny! We appreciate your efforts in making this project better.
barcode-constrained-phylogeny © 2023, Naturalis Biodiversity Center. Released under the MIT license.