From 325bd9e504cbbef27ab60ef6fab502aeba3c7afa Mon Sep 17 00:00:00 2001
From: Holly Gong <39108850+hogo6002@users.noreply.github.com>
Date: Fri, 16 Aug 2024 13:22:10 +1000
Subject: [PATCH] docs: add Git conventional commit requirement (#2483)

add [Git conventional
commit](https://www.conventionalcommits.org/en/v1.0.0/) requirement to
keep commit history clean.
---
 CONTRIBUTING.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1435e9015c7..8bb42b93b95 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -130,6 +130,12 @@ gcloud auth login --update-adc
 make run-api-server
 ```
 
+### Making commits
+
+Please follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for commit messages. This helps us to automate processes like changelog generation and ensures a clear and consistent commit history.
+
+Some types: `feat:`, `fix:`, `docs:`, `chore:`, `refactor:`, and others.
+
 ## Contributing data
 
 Data contributions are also welcome!