Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 884 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 884 Bytes

Contributing

We welcome contributions to this repository!

Please use the following guidelines for contributing.

We distinguish two types of contributions: new templates, and changes to the structure of the API.

New templates

For adding new templates, install the packages in requirements-dev.txt in a new virtual environment, then follow the steps described here

Editing the main structure of the API

We use a Docker container. Please see the docker documentation

Linting

We use Flake8 and Black for linting Python code. If you have installed the packages in requirements-dev.txt, you can simply run the following:

flake8 path-to-file
black path-to-file