Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

33 lines (19 loc) · 1.25 KB

Contributing to TRIUMF RICH AI project


We welcome all contributions to this project! If you notice a bug, or have a feature request, please open up an issue here. If you’d like to contribute a feature or bug fix, you can fork our repo and submit a pull request. We will review pull requests within 7 days. All contributors must abide by our code of conduct.

Fixing Typos


Small edits or changes to errors in the documentation can be directly modified through GitHub's web interface. These changes must be made within the source file.

Prerequisites


Before making a substantial pull request, you must create an issue to ensure that project maintainers agree with the problem or specified change. If a bug has been identified, please create an issue with a minimal reproducible example to demonstrate the bug.

Pull request process


  • It is advised that pull requests are created in GitHub branches
  • Any new code should apply the PEP8 python style
  • Use Markdown syntax, for documentation or proper docstrings for python functions

Code of Conduct


Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.