Skip to content

Commit

Permalink
updated CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KatyBrown authored Feb 22, 2024
1 parent 09e3571 commit cbae80e
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,21 @@ You can contribute to plot_phylo in the following ways:
- Forking the repository and improving the code
- Improving documentation

If contributing to plot_phylo, please ensure that you

* Add any new functionality to the README.md documentation, following the style of the rest of the document.
* Edit function docstrings to include any new variables and include docstrings in the same style for any new functions.
* Add comments to describe how your code works.
* Edit the unit tests to include any new functionality.
* Run unit tests in the root directoy as `pytest --cov=plot_phylo` then view the coverage html and ensure that they pass and that module file coverage is 100%.
* Check the code is pep8 compliant.

If you're unsure about any of these steps, please raise an issue and I can help you.

## Code of Conduct

Please review our Code of Conduct before participating. Be kind and respectful to fellow contributors.

## License

By contributing to [Your Project Name], you agree that your contributions will be licensed under the MIT License.
By contributing to ploy_phylo, you agree that your contributions will be licensed under the MIT License.

0 comments on commit cbae80e

Please sign in to comment.