prepare repo
This commit is contained in:
57
CONTRIBUTING.md
Normal file
57
CONTRIBUTING.md
Normal file
@ -0,0 +1,57 @@
|
||||
# Contributing
|
||||
|
||||
## Branching
|
||||
|
||||
Follow `BRANCHING.md` for long-lived and task branch rules.
|
||||
|
||||
## 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:
|
||||
|
||||
```bash
|
||||
bun run changelog:release
|
||||
```
|
||||
|
||||
- For preview output only:
|
||||
|
||||
```bash
|
||||
bun run changelog:preview
|
||||
```
|
||||
Reference in New Issue
Block a user