Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1017 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1017 Bytes

Contributing to django-headless-cms

Contributions are welcome! Here are some pointers to help you install the library for development and validate your changes before submitting a pull request.

Install the library for development

First create your own venv and activate it:

pythin -m venv .venv
source .venv/bin/activate

Then we recommend installing initial requirements and use poetry install all dev package:

pip install requirements-init.txt
poetry install --all-extras

Validate the changes before creating a pull request

  1. Prepare for test:
  • Docker running
  • Run docker-compose up to create testing postgresql database.
  1. Make sure the existing tests are still passing (and consider adding new tests as well!):
pytest --cov-report term-missing --cov=headless_cms tests
  1. Reformat and validate the code with the following tools:
bash scripts/lint.sh [--fix]

These steps are also run automatically in the CI when you open the pull request.