From 3ac49f5a95a31ceb2c2f09c7c1a2c871e8bdb38d Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Tue, 2 Apr 2024 08:24:29 +0200 Subject: [PATCH] docs: add a note about Git commit format --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83df5698..06f4a687 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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