Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (23 loc) · 808 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 808 Bytes

Contributing

This defines the standards for contributing to the project.

Contributing code

This project enforces several style guidelines via pre-commit which will need to be installed.

pre-commit install

Utilizing LLM/AI in project code

LLM/AI generated code is accepted as long as it's been reviewed and vetted. It should be noted in the commit message with a Co-Authored-By attribution.

Running the tests

The tests can be run using tox:

uv run tox -e py312-django52

To see all environments, run:

uv run tox -l

Running the example app

There is an example app that can be run to experiment with the project:

uv run python example_project/manage.py runserver --settings example.settings