Skip to content

Latest commit

 

History

History
32 lines (17 loc) · 646 Bytes

CONTRIBUTING.md

File metadata and controls

32 lines (17 loc) · 646 Bytes

Contributing Guide

This doc covers dev setup and guidelines for contributing.

FIXME: This doc is a stub.

Requirements

  • python3.6+, pip, virtualenv

Recommended

Linting

Linting can be run via pre-commit. Run for all files in the repo:

pre-commit run -a

(Optional) Setup pre-commit Hooks

For the best development experience, set up linting and autofixing pre-commit git hooks using the pre-commit tool.

After installing pre-commit, run

pre-commit install

in the repo to configure hooks.

NOTE: If necessary, you can always skip hooks with git commit --no-verify