Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 810 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 810 Bytes

Contributing

Getting started with development

Setup

There are several ways to create your isolated environment. This is the default method.

Run the following in a terminal:

# Clone the repository
git clone https://github.com/callowayproject/psmq.git

# Enter the repository
cd psmq

# Create then activate a virtual environment
python -m venv venv
source venv/bin/activate

# Install the development requirements
python -m pip install -r requirements/dev.txt

Run tests

Once setup, you should be able to run tests:

pytest

Install Pre-commit Hooks

Pre-commit hooks are scripts that run every time you make a commit. If any of the scripts fail, it stops the commit. You can see a listing of the checks in the .pre-commit-config.yaml file.

pre-commit install