| Type | Pattern | Example |
|---|---|---|
| Feature | feature/<short-description> |
feature/add-gear-devices |
| Bug fix | fix/<short-description> |
fix/login-redirect |
| Security | fix/<cve-or-package> |
fix/dompurify-xss |
| Maintenance | chore/<short-description> |
chore/github-project-setup |
| Docker/infra | chore/<short-description> |
chore/image-optimization |
- Open an issue first for non-trivial changes
- Branch from
main, keep PRs focused on one thing - Use
Closes #<issue>in the PR description to auto-close the issue on merge - Update
CHANGELOG.mdunder the relevant section for the upcoming version - Bump versions in
package.json(root,runner/,helper/) only when cutting a release
Releases are triggered by pushing a version tag:
git tag v1.x.x
git push origin v1.x.xThis kicks off the GitHub Actions workflow that builds and publishes Docker images for all three services (config-tool, runner, helper).
See README.md for installation and local dev instructions.