docs: document commit convention
This commit is contained in:
parent
d5d803fa60
commit
01611e167f
@ -65,6 +65,14 @@ These are duplicated as local constants across files; keep them in sync when cha
|
|||||||
- Programs accept `-version`/`--version` and `-help`/`--help` (and `-silent`/`--silent` for the router) via vararg `...`.
|
- Programs accept `-version`/`--version` and `-help`/`--help` (and `-silent`/`--silent` for the router) via vararg `...`.
|
||||||
- French comments appear throughout — fine to add either language, match the surrounding file.
|
- French comments appear throughout — fine to add either language, match the surrounding file.
|
||||||
|
|
||||||
|
### Commit messages
|
||||||
|
|
||||||
|
Commit messages roughly follow Angular-style conventional commits, but the convention is intentionally lightweight. Use either `topic(scope): description` or `topic: description`.
|
||||||
|
|
||||||
|
- Common topics include `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `ci`, and `revert`.
|
||||||
|
- Keep the description short, lowercase, imperative, and without a trailing period.
|
||||||
|
- The exact topic/scope matters less than making the commit easy to scan.
|
||||||
|
|
||||||
## Development setup
|
## Development setup
|
||||||
|
|
||||||
See `DEVELOPMENT.md` for local development requirements and setup steps.
|
See `DEVELOPMENT.md` for local development requirements and setup steps.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user