Branching Strategy¶

This repository uses a simple trunk based workflow.

Main Branch¶

The main branch always represents the latest stable code.

All work should be merged back into main through a pull request.

Feature Branches¶

Create a short lived branch for each change.

Format¶

<type>/<description>

Examples:

feature/log-middleware
feature/view-mixin

fix/blocked-request
fix/infinite-log

refactor/transaction-middleware

docs/development-setup

test/account-signals

chore/django-upgrade

ci/pypi-integration

Use lowercase letters and hyphens (-) between words.

Branch Types¶

feature¶

New functionality.

Examples:

feature/email-serializer

fix¶

Bug fixes.

Examples:

fix/redirect-method

refactor¶

Code restructuring without behavior changes.

Examples:

refactor/calculation-method

docs¶

Documentation changes.

Examples:

docs/contributing-guide

test¶

Testing related work.

Examples:

test/auth-coverage

ci¶

CI/CD and automation changes.

Examples:

ci/github-cache

chore¶

Maintenance tasks.

Examples:

chore/django-upgrade