The following is a set of guidelines for contributing to our metagenomics workflows, which are hosted on the Signature Science Organization GitHub (https://github.com/signaturescience).
Would you like to report a bug? Search the GitHub Issues to ensure that the bug was not already reported. If you're unable to find an open issue addressing the problem, please open a new one. Be sure to include an informative title and description of the issue, along with as much relevant information as possible. The new issue should include a code sample or an executable test case that demonstrates how the expected behavior is not occurring.
Have you written a patch to fix a bug? Thank you! Please open a new GitHub pull request that includes your patch. Clearly describe the problem and solution in your pull request description, and if applicable, include a relevant issue number.
Do you intend to add a new feature or change an existing one? Before submitting a pull request with new features or significant modifications to the existing code base, please start a discussion about your ideas and intended contributions by emailing git@signaturescience.com. Once you have received positive feedback from Signature Science, you should create a fork of the original repository, make changes to your fork, and submit a new GitHub pull request with your changes. Include a clear list of what you have done along with informative commit log messages. The pull request will be reviewed by Signature Science before it is merged into the code base.
Do you have questions about the source code? Questions can be emailed to git@signaturescience.com, and subsequent clarifications will be made by Signature Science to the readme file, wiki, or code as needed.
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer at git@signaturescience.com.
This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available from https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html