CONTRIBUTING.md

How to contribute!

Did you find a bug?

• Ensure the bug was not already reported by searching on GitHub under Issues.

• If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

• Open a new GitHub pull request with the patch.

• Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of this codebase and will generally not be accepted.

Thanks! Read on for technical details below to get your environment ready to build.

Technical Guide

Assuming you have cloned this repository to your local machine, you can follow these guidelines to make contributions.

First, please install pyenv https://github.com/pyenv/pyenv to manage your python environment.

Install the version of python as mentioned in this repo.

pyenv install $(cat .python-version)

Use a virtual environment

python -m venv .venv

This will create a directory .venv with python binaries and then you will be able to install packages for that isolated environment.

Next, activate the environment.

source .venv/bin/activate

To check that it worked correctly;

which python pip

You should see paths that use the .venv/bin in your current working directory.

Installing with Flit

This project uses flit to manage our project's dependencies.

Install dependencies, including flit.

./scripts/install.sh
pyenv rehash

Formatting

./scripts/format.sh

Tests

./scripts/test.sh