67 lines
1.3 KiB
Markdown
67 lines
1.3 KiB
Markdown
# Contributing
|
|
|
|
## Branching
|
|
|
|
Follow `BRANCHING.md` for long-lived and task branch rules.
|
|
|
|
Pull requests should use `.gitea/PULL_REQUEST_TEMPLATE.md` and link the exact TODO item.
|
|
|
|
## Commit Message Schema
|
|
|
|
This repository uses Conventional Commits.
|
|
|
|
Pattern:
|
|
|
|
```
|
|
<type>(<scope>): <description>
|
|
```
|
|
|
|
Examples:
|
|
|
|
- `feat(admin): add todo priority filter`
|
|
- `fix(web): handle missing header banner fallback`
|
|
- `refactor(db): split post repository methods`
|
|
- `test(e2e): add commission kanban smoke flow`
|
|
- `chore(ci): add changelog generation step`
|
|
|
|
Recommended types:
|
|
|
|
- `feat`
|
|
- `fix`
|
|
- `refactor`
|
|
- `perf`
|
|
- `test`
|
|
- `docs`
|
|
- `build`
|
|
- `ci`
|
|
- `chore`
|
|
- `revert`
|
|
|
|
Rules:
|
|
|
|
- Keep subject line short and imperative.
|
|
- Use scope when possible (`admin`, `web`, `db`, `ci`, `todo`, etc.).
|
|
- One branch should primarily address one TODO item.
|
|
|
|
## Changelog Process
|
|
|
|
- Keep commit messages conventional.
|
|
- Generate/update `CHANGELOG.md` with release-focused sections (includes `Unreleased`):
|
|
|
|
```bash
|
|
bun run changelog:release
|
|
```
|
|
|
|
- For preview output only:
|
|
|
|
```bash
|
|
bun run changelog:preview
|
|
```
|
|
|
|
- For exhaustive output across all allowed commit types (`feat`, `fix`, `docs`, `test`, `ci`, `chore`, `refactor`, etc.):
|
|
|
|
```bash
|
|
bun run changelog:full:preview
|
|
bun run changelog:full:release
|
|
```
|