Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 1.36 KB
Raw

Contributing to pygitguardian

Getting involved

Development is coordinated via the issue tracker exclusively.

If you want to propose large changes be sure to communicate with other contributors through an issue tagged as feature request about the design and the benefits of such change.

Bug Reporting

When submitting a bug report be sure that:

  • You are using the latest version of the package
  • There are no issues describing the same behaviour on the issue tracker

Dev environment

pipenv install --dev
pipenv run pre-commit install -f --hook-type commit-msg --hook-type pre-commit

Testing

Pygitguardian testing is done with pytest. You should make sure your changes don't report any error on:

make test

Conventions

pygitguardian follows conventional commit messages link.

Line length

Line length in the one enforced by Black: 88 characters.

DocString

  • Use sphinx style docstrings
  • There are never too many docstrings
  • If the docstring will take more than 1 line, start directly below """
  • The first sentence starts with a capital letter and ends with a point. This sentence is separated from the others by a blank line
  • Docstrings must have :params: if the function has 2 or more arguments.
  • All docstrings must state the return object and raised exception with :return: and :raise: