Skip to content

Latest commit

 

History

History
31 lines (16 loc) · 1011 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (16 loc) · 1011 Bytes
Raw

Contributing

Security

For security issues, see SECURITY.

Bugs and issues

Please raise non-security bugs and suggestions in the Issues on the GitHub-hosted repository.

Developing

Please use Python 3.8+, and use make lint to apply the coding standards. You can safely ignore errors from vulture, but please act on all other errors and warnings (either correct the code, or suppress the error, if justified).

Building

Use make to apply the linter and package the wheel.

If you want to build the distributable binary, then please use make nuitka on the platform you want the binary for.

Submitting changes

Please fork the repository, and raise a Pull Request (PR) for review.

Remember to update the README and CHANGELOG, and the version number in pyproject.toml

Your changes must be acceptable under the LICENSE of the project.

Code of conduct

Follow the Code of Conduct.