Contributions to Fargonaut are welcome.
If you have a suggestion, please open an issue describing in detail the change you would like to be made.
Similarly, if you have found a bug or a mistake, please open an issue describing this in detail.
If you would like to contribute code, please:
-
Open an issue to detail the change/addition you wish to make, unless one already exists
-
Fork the repository
-
Make a clone of your fork
-
Install the development requirements
$ python -m unittest discover tests
-
Install the pre-commit hooks:
$ python -m unittest discover tests
-
Create a feature branch and make your changes
-
Ensure that all tests pass
- Run the tests via
$ python -m unittest discover tests
- Check the test coverage via
$ coverage run --omit=tests/* -m unittest discover tests $ coverage report -m -
Ensure that the documentation builds successfully
- Build the documentation via
$ cd docs $ make html -
Open a pull request. In the pull request description, please describe in detail the changes your feature branch introduces, and reference the associated issue.