Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 1.94 KB

How to contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

First, read these guidelines. Before you begin making changes, state your intent to do so in an Issue. Then, fork the project. Make changes in your copy of the repository. Then open a pull request once your changes are ready. A discussion about your change will follow, and if accepted, your contribution will be incorporated into the project codebase.

Code reviews

All submissions, including submissions by project members, require review. Consult GitHub Help for more information on using pull requests.

Code style

In general, the project follows the guidelines in the Google Python Style Guide.

In addition, the project follows a convention of:

  • Maximum line length: 80 characters
  • Indentation: 4 spaces
  • PascalCase for function and method names.
  • No type hints, as described in PEP 484, to maintain compatibility with Python versions < 3.5.
  • Single quotes around strings, three double quotes around docstrings.

Testing

Use GitHub Actions to run tests on each pull request. You can run these tests yourself as well. To do this, first install the test dependencies:

pip install -r ./tests/requirements.txt

And then run the tests:

pytest tests

Linting

Please run lint on your pull requests to make accepting the requests easier. To do this, run pylint or a similar tool in the root directory of the repository. Note that even if lint is passed, additional style changes to your submission may be made during merging.

References