feature: GIT commit message 提交规范 (closed TencentBlueKing#2080)

.github/ISSUE_TEMPLATE/bug_report_zh.md

@@ -1,7 +1,7 @@
 ---
 name: Bug 反馈
 about: Bug 反馈
-title: "[BUG]"
+title: "fix: "
 labels: backlog, kind/bug
 assignees: ''
 

.github/ISSUE_TEMPLATE/enhancement_no_pending.md

@@ -1,7 +1,7 @@
 ---
 name: 技术需求（无需评审）
 about: 技术需求（无需评审）
-title: "[FEATURE] "
+title: "feat: "
 labels: backlog, kind/feature
 assignees: ZhuoZhuoCrayon
 

.github/configuration.json

@@ -6,15 +6,15 @@
       },
       {
         "title": "### 🚀 Features",
-        "labels": ["kind/feature", "feature", "feat(front)"]
+        "labels": ["kind/feature", "feature", "feat(front)", "feat"]
       },
       {
         "title": "### ✨ Optimizations",
-        "labels": ["kind/optimization", "optimization", "perf(front)", "optimize(front)", "style(front)"]
+        "labels": ["kind/optimization", "optimization", "perf(front)", "optimize(front)", "style(front)", "style", "perf"]
       },
       {
         "title": "### 🐛 Bugfixes",
-        "labels": ["kind/bugfix", "bugfix", "fix(front)"]
+        "labels": ["kind/bugfix", "bugfix", "fix(front)", "fix"]
       },
       {
         "title": "### ✏️ Docs",
@@ -26,7 +26,7 @@
       },
       {
         "title": "## 📦 Dependencies",
-        "labels": ["build(front)"]
+        "labels": ["build(front)", "chore"]
       }
     ],
     "sort": "ASC",
@@ -35,11 +35,11 @@
     "empty_template": "- no changes",
     "label_extractor": [
       {
-        "pattern": "^(feature|docs|bugfix|optimization|refactor|test):(.*)",
+        "pattern": "^(feature|docs|bugfix|optimization|refactor|test|feat|fix|style|chore):(.*)",
         "target": "$1"
       },
       {
-        "pattern": "^(refactor|feat|perf|optimize|fix|docs|test|build|style)\\(front\\):(.*)",
+        "pattern": "^(refactor|feat|perf|optimize|fix|docs|test|build|style|chore)\\(front\\):(.*)",
         "target": "$1(front)"
       }
     ],
@@ -50,11 +50,11 @@
     },
     "transformers": [
       {
-        "pattern": "^(feature|docs|bugfix|optimization|refactor|test):\\s*(.*)",
+        "pattern": "^(feature|docs|bugfix|optimization|refactor|test|feat|fix|style|chore):\\s*(.*)",
         "target": "$2"
       },
       {
-        "pattern": "^(feature|docs|bugfix|optimization|refactor|test)\\(front\\):\\s*(.*)",
+        "pattern": "^(feature|docs|bugfix|optimization|refactor|test|feat|fix|style|chore)\\(front\\):\\s*(.*)",
         "target": "$2"
       }
     ]

pre-commit.md

@@ -80,24 +80,21 @@ https://python-modernize.readthedocs.io/en/latest/fixers.html#
 
 commit message 必须包含以下前缀之一:
 
-`feature`     	- 新特性
+`feat`       	- 新功能/特性
 
-`bugfix`      	- 线上功能bug
+`fix`      	  - Bug修复
 
-`minor`       	- 不重要的修改（换行，拼写错误等）
+`docs`       	- 仅文档更改
 
-`optimization`	- 功能优化
+`style`	      - 不影响代码含义的更改（空格、格式、缺少分号等）
 
-`sprintfix`   	- 未上线代码修改 （功能模块未上线部分bug）
+`refactor`   	- 既不修复错误也不添加功能的代码更改
 
-`refactor`    	- 功能重构
+`perf`    	- 既不修复错误也不添加功能的代码更改
 
-`test`        	- 增加测试代码
-
-`docs`        	- 编写文档
-
-`merge`       	- 分支合并及冲突解决
+`test`        	- 添加缺失的测试或更正现有测试
 
+`chore`        	- 对构建过程或辅助工具和库（如文档生成）的更改
 
 # 4. 附录
 

scripts/workflows/pre-commit/check_commit_message.py

@@ -24,15 +24,14 @@
 
 
 ALLOWED_COMMIT_MSG_PREFIX = [
-    ("feature", "新特性"),
-    ("bugfix", "线上功能bug"),
-    ("minor", "不重要的修改（换行，拼写错误等）"),
-    ("optimization", "功能优化"),
-    ("sprintfix", "未上线代码修改 （功能模块未上线部分bug）"),
-    ("refactor", "功能重构"),
-    ("test", "增加测试代码"),
-    ("docs", "编写文档"),
-    ("merge", "分支合并及冲突解决"),
+    ("feat", "新功能/特性"),
+    ("fix", "Bug修复"),
+    ("docs", "仅文档更改"),
+    ("style", "不影响代码含义的更改（空格、格式、缺少分号等）"),
+    ("refactor", "既不修复错误也不添加功能的代码更改"),
+    ("perf", "提高性能的代码更改"),
+    ("test", "添加缺失的测试或更正现有测试"),
+    ("chore", "对构建过程或辅助工具和库（如文档生成）的更改"),
 ]
 
 
@@ -54,7 +53,7 @@ def get_commit_message():
 def main():
     content = get_commit_message()
     for prefix in ALLOWED_COMMIT_MSG_PREFIX:
-        if content.startswith(prefix[0]):
+        if content.startswith(f"{prefix[0]}:"):
             return 0
 
     else: