Thank you for considering contributing to rl4mm!
Please read our Code of Conduct first to help us to maintain a friendly and helpful community.
Please feel free to open a Pull Request for any minor changes to the repository. For larger changes, please open an
issue first to discuss with other users and maintainers of rl4mm. If you are not familiar with creating a Pull
Request, here are some guides:
- http://stackoverflow.com/questions/14680711/how-to-do-a-github-pull-request
- https://help.github.com/articles/creating-a-pull-request/
We use mypy as a static type checker, Flake8 to enforce PEP8 and Black to enforce consistent styling.
- Code will be automatically reformatted with:
invoke black-reformat - Styling and type checking tests can be run locally with:
invoke check-python
When adding new code to the rl4mm code-base, please add test coverage wherever possible.
We use unittest for unit testing. All unit tests can be run by
calling nose2 from the root directory.