Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 1.47 KB
Raw

How to contribute

All contributions, ideas and bug reports are more than welcome! We encourage you to open an issue for any change you would like to make on this project.

Workflow

If you wish to contribute, please follow this process:

  • Fork the main branch of the repository.
  • Clone your fork locally.
  • Set up your environment (see Dependencies section below).
  • Commit your work after ensuring it meets the guidelines described below (code style).
  • Push to your fork.
  • Open a pull request from your fork back to the original main branch.

Dependencies

We use venv to manage the dependencies. In order to run the needed scripts you need to have python installed and run the command below.

python3 -m venv /path/to/new/virtual/environment

To activate your venv run source "env_name"/bin/activate.

To install dependencies run the command:

pip install -r requirements.txt

Code style

Black is already into the dependencies (requirements.txt)

Before submitting

Before submitting your code please do the following steps:

  1. Add any changes you want
  2. Add tests for the new changes
  3. Edit documentation if you have changed something significant

Other help

You may also help by letting others know about this repository. If you could tell us how you're using it and what your best practices are, that would be really interesting to us.