Skip to content

Latest commit

 

History

History
47 lines (25 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

47 lines (25 loc) · 1.33 KB

Contributing Guide

This project was created using footing. For more information about footing, go to the footing docs.

Setup

Set up your development environment with:

git clone [email protected]:Opus10/django-pgtrigger.git
cd django-pgtrigger
make docker-setup

make docker-setup will set up a development environment managed by Docker. Install docker here and be sure it is running when executing any of the commands below.

If you prefer a native development environment, make conda-setup will set up a development environment managed by Conda. Dependent services, such as databases, must be ran manually.

Testing and Validation

Run the tests on one Python version with:

make test

Run the full test suite against all supported Python versions with:

make full-test-suite

Validate the code with:

make lint

If your code fails the linter checks, fix common errors with:

make lint-fix

Documentation

Mkdocs Material documentation can be built with:

make docs

A shortcut for serving them is:

make docs-serve

Releases and Versioning

The version number and release notes are manually updated by the maintainer during the release process. Do not edit these.