Contributing to MAHOS#

Thank you so much for investing your time in contributing to our project. Any contributions, including bug reports and patches, are always welcome.

Bug reports#

Please submit a new issue for a bug report.

Patches#

Please submit a pull request for your patch after reviewing the notes below.

Testing#

Please use the following commands in the project’s root directory to check whether your patch can be merged. You can also hit make to do all.

  • black . to format the code.

  • flake8 . for code linting.

  • pytest to check whether all the unit tests are passing.

Contributor License Agreement#

To avoid possible legal (copyright, patent, etc.) disputes, we ask you to sign the Contributor License Agreement (CLA) before merging your contribution. The signing process can be done on the GitHub pull request page. Please follow the instructions by “CLA Assistant Lite bot” there.

Maintainers#

If you have any questions which you would like to ask in private, contact one of the maintainers below.