docs: add a note about Git commit format

This commit is contained in:
Vincent Bernat
2024-04-02 08:24:29 +02:00
parent bcaad7a49c
commit 3ac49f5a95

View File

@@ -25,6 +25,10 @@ Go formatter takes care of most issues. For the remaining points:
[prometheus conventions]: https://prometheus.io/docs/practices/naming/
Git commits are prefixed with the component and sub-component of the feature:
`orchestrator/clickhouse: add some feature`. Meta-component are also possible,
like `docs`, `build`, or `docker`.
# Testing
We do not aim for 100% code coverage, however most code should be covered by