Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.05 KB

contribution.rst

File metadata and controls

30 lines (22 loc) · 1.05 KB
Raw

Contribution

This is an open source project and lives by and with the contribution of the community. Any help is highly welcome and appreciated:

  • testing the library with other PDFs
  • reporting bugs or feature requests on Github
  • uploading a pull request

For code base changes it often makes sense to create a new issue before uploading a pull request. You can get in touch with the maintainers and agree on the best implementation approach. Small changes like fixing a typo, contributing to the documentation commonly don't need an issue.

Here are some things worth noting before uploading commits:

  • all code must follow the black code style

  • black is configured to

    • a maximum line length of 120 chars and
    • single quote string literals

  • pull requests are checked using tox

  • tox executes (for various Python versions)

    • pytest
    • flake8 with various plugins (see pyproject.toml)
    • pylint
    • black
    • the Sphinx documentation build