CONTRIBUTING.md

How to Contribute

This page list all the steps you need to follow to set up model_bakery and be able to code it. Here they are:

1. Fork this repo and clone it to your computer:

git clone [email protected]:YOUR_USER/model_bakery.git

2. Install the dev dependencies:

pip install .[test]

3. Change the code and run your tests with:

make test

4. We use pre-commit to ensure a unique code formatting for the project. But, if you ran into any CI issues with that, make sure your code changes respect it:

make lint

If you don't follow the step 4, your PR may fail due to black or ruff warnings.

To run postgresql and postgis specific tests:

1. Install docker.

2. Install the postgis dependencies. Follow the instructions from the Django docs:

If you are on Ubuntu/Debian you run the following:

sudo apt update -y && sudo apt install -y binutils libproj-dev gdal-bin

3. Run the following script:

./postgis-tests.sh

That will spin up a docker container with postgresql and postgis enabled and run the full test suite.