Developer guide

This guide helps you get started developing github-docs-cookiecutter.

Development Strategy

All Makefile commands are used in ci/cd to ensure that if they pass locally they should also pass once pushed to github.

🐍️ Build environment (.venv)

$ make install

🧬 Dependency Management (deptry)

$ make dependency-check

🛡️ Security Audit (pip-audit)

$ make security

🎨 Formatting (black)

$ make format-check

$ make format-fix

🔍 Linting (djlint, ruff, tomllint, & yaml-lint)

$ make lint-check

$ make lint-fix

🎓 Spellchecking (codespell)

$ make spellcheck

🧠 Typechecking (mypy)

$ make typecheck

🧪 Testing (pytest)

$ make test

🚀 Release (git tag)

$ make release

❓ Build Help

$ make help