profilarr/docs/DEVELOPMENT.md

Development

Branching Strategy

Profilarr uses GitHub Flow with Release Channels.

• All development happens on main
• Feature branches for isolated work
• Tags trigger Docker image builds

Release Channels

Channel	Docker Tag	Trigger	Stability
Develop	:develop	Every push to main	Unstable
Beta	:beta	v*-beta.* tag	Testing
Stable	:latest	v* tag (no -beta)	Stable

Version-specific tags (:v2.1.0) are also created for pinning.

Development Workflow

Daily Work

git add .
git commit -m "feat: description"
git push

Pushes to main automatically build the :develop image.

Feature Branches

For larger features, use a branch:

git checkout -b feature/name
# work...
git checkout main
git merge feature/name
git branch -d feature/name

Release Process

1. Beta Release

git tag v2.1.0-beta.1
git push --tags

2. Beta Fixes

git commit -m "fix: issue from beta"
git push
git tag v2.1.0-beta.2
git push --tags

3. Stable Release

After minimum 1 week in beta with no major issues:

git tag v2.1.0
git push --tags

Release Timing

Stable Releases: Wednesday

• Beta releases can be tagged any day. Must be in beta for at least a week before tagged as stable

Versioning

Semantic Versioning:

v2.1.0-beta.1
│ │ │    └──── Pre-release identifier
│ │ └───────── Patch (bug fixes)
│ └─────────── Minor (new features, backwards compatible)
└───────────── Major (breaking changes)

Change	Bump
Bug fix	v2.1.0 → v2.1.1
New feature	v2.1.0 → v2.2.0
Breaking change	v2.1.0 → v3.0.0

Commit Messages

Use Conventional Commits:

feat: add new feature
fix: resolve bug
docs: update documentation
refactor: restructure code
chore: maintenance tasks

Hotfixes

For critical bugs in stable:

git commit -m "fix: critical issue"
git push
git tag v2.1.1
git push --tags