Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 1.4 KB

Contributing to CHAMP

Thanks for your interest in CHAMP!

Contributions are welcomed from everyone, particularly those with expertise in high performance computing. At the moment we don't have a road map for development but this is planned.

Please follow the below guidelines to help us work together smoothly.

  • Always follow our Code of Conduct
  • Please use a GitHub issue to report bugs, request features or ask any questions.
  • Please comment on an existing issue or create a new one to discuss any planned contribution before you make it.
  • To make a contribution please fork the repository, create a new branch starting from develop, make your changes, then create a pull request against develop. All tests and QA checks must be passing before your branch can be reviewed.
  • CHAMP uses Flake8 and black to ensure consistent code style. We strongly suggest using pre-commit to ensure these are applied to all of your commits.
  • If your contribution adds new functionality there must be tests cover this.

Code of Conduct

CHAMP uses the Contributor Covenant. Please report any violations to Christopher Cave-Ayland ([email protected]).