From f4cf51b9019fb4fd46d61a924aab558c6526e8da Mon Sep 17 00:00:00 2001
From: ZhangJian He <shoothzj@gmail.com>
Date: Sat, 23 Mar 2024 15:02:32 +0800
Subject: [PATCH] ci: add convertional commit lint

Signed-off-by: ZhangJian He <shoothzj@gmail.com>
---
 .github/workflows/build.yml       |  2 +-
 .github/workflows/commit_lint.yml | 12 ++++++++++++
 .github/workflows/license.yml     |  2 +-
 CONTRIBUTING.md                   |  4 +++-
 4 files changed, 17 insertions(+), 3 deletions(-)
 create mode 100644 .github/workflows/commit_lint.yml

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 7069497e059..38ce14daf9c 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -31,7 +31,7 @@ jobs:
       matrix:
         jdk: [8, 11, 17]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up JDK
       uses: actions/setup-java@v1
       with:
diff --git a/.github/workflows/commit_lint.yml b/.github/workflows/commit_lint.yml
new file mode 100644
index 00000000000..0bd90b9df48
--- /dev/null
+++ b/.github/workflows/commit_lint.yml
@@ -0,0 +1,12 @@
+name: commit lint
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: wagoid/commitlint-github-action@v5
diff --git a/.github/workflows/license.yml b/.github/workflows/license.yml
index 557ba26f88d..b8e6b6ff683 100644
--- a/.github/workflows/license.yml
+++ b/.github/workflows/license.yml
@@ -28,6 +28,6 @@ jobs:
   license:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Check License
       uses: apache/skywalking-eyes/header@501a28d2fb4a9b962661987e50cf0219631b32ff
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5455a2531b5..4e7d7c43f76 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,4 +32,6 @@ We provide template files [intellij-java-google-style.xml](https://github.com/ct
         * `git checkout -b <some-branch-name> <remote>/master`
         * `git merge --squash <current-feature-branch>`
 
-* When writing a commit message please follow these conventions: if you are fixing an existing issue, please add Fixes #XXX at the end of the commit message (where XXX is the issue number).
+* For commits, we adhere to the conventional commits format. For more details, refer to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+* When crafting commit messages, please adhere to the following conventions: if your commit addresses an existing issue, append "Fixes #XXX" to the end of the commit message (where XXX is the issue number).