Skip to content

Latest commit

 

History

History
58 lines (43 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

58 lines (43 loc) · 1.02 KB

How to Contribute

Developing Guidelines - Pull Request

Pull requests are welcomed along with the following:

  • PR documenting what is changed, why it is changed / needed
  • Pre-commit formatting, otherwise LINT will fail
  • New / Update to tests for new functionality
  • tests should pass all trio db - sqlite, mysql, postgres

Requirements

Known Linux Requirements

sudo apt-get install libmysqlclient-dev & libpq-dev

Create Virtual Environment

virtualenv -p python3 py-env

Activate

source py-env/bin/activate

Install Depedencies

(py-env) $ pip install -r requirements-test.txt

Setup Pre Commit

(py-env) $ pre-commit install

Run Tests

Tests can be started via vscode debugger, or using make

Start DB container, for MySql or Postgres

docker-compose up mysql -d
docker-compose up postgres -d

Set ENV for tests being run

export ENV='sqlite|mysql|postgres'

(py-env) $ make test

(py-env) $ make test-migrations