From ff0f6b1cf2521169ef9f89e9a8d383bcf4ecfa49 Mon Sep 17 00:00:00 2001 From: 13812773784 Date: Sat, 16 May 2026 13:38:55 +0800 Subject: [PATCH 1/4] chore(commit-rule): add git commit message specification document This commit adds the formal Conventional Commits based git commit guideline for the archive project, including basic format, examples, allowed commit types and PR template. --- .trae/rules/git-commit-message.md | 94 +++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 .trae/rules/git-commit-message.md diff --git a/.trae/rules/git-commit-message.md b/.trae/rules/git-commit-message.md new file mode 100644 index 0000000..30ba836 --- /dev/null +++ b/.trae/rules/git-commit-message.md @@ -0,0 +1,94 @@ +--- +alwaysApply: true +scene: git_message +--- + +在此处编写规则，自定义 AI 生成提交信息的风格。 + +## 提交信息 + +档案馆项目采用 Conventional Commits 规范来格式化提交信息。全部内容都使用英文。 + +### 基本格式 + +每条提交信息应遵循以下结构： + +```text +<类型>(<可选的作用域>): <描述> + +[可选的正文（英文）] + +[可选的脚注（英文）] +``` + +- **类型**：必填，表示本次提交的类别（见下文“类型列表”）。 +- **作用域**：可选，用括号包裹，指明本次提交影响的代码范围（如模块名、组件名等）。 +- **描述**：必填，是对变更的简短说明，使用祈使句、现在时态，首字母小写，末尾不加句号。 +- **正文**：可选，对变更动机及与之前行为的对比进行详细说明。 +- **脚注**：可选，主要用于关联 Issue 或标记破坏性变更（BREAKING CHANGE）。 + +### 示例 + +1. 新增一个用户登录功能： + + ```text + feat(auth): add user login endpoint + ``` + +2. 修复身份验证模块中未处理空值的问题： + + ```text + fix(auth): resolve unhandled null value in token validation + ``` + +3. 包含破坏性变更的提交（需在脚注中标记）： + + ```text + feat(api): change response format for user details + + BREAKING CHANGE: The 'user' field in the response is now nested under 'data'. + ``` + +4. 关联 Issue 的提交： + + ```text + fix(ui): correct button alignment on mobile devices + + Closes #12 + ``` + +## PR 格式 + +### 描述 + +PR 的描述部分应包含足够的信息供审查者理解变更背景和具体内容。推荐使用以下模板结构： + +```markdown +## Changes +- 简要列出主要的功能变更或修复点。 +- 可以使用列表形式清晰展示。 +- 例如： + - Added login endpoint with email/password authentication and session token management + +## Related +- 关联相关的 Issue 编号，使用 `#` 符号引用。 +- 例如： + - Closes #123 + - Related to #456 +` + +## 类型列表 + +以下是项目中允许使用的提交与分支类型： + +- `feat`：新增功能。 +- `fix`：修复 bug。 +- `update`: 对代码内容做出调整，而原先的代码不视为 bug（如修改前端按钮的文案） +- `docs`：仅修改文档。 +- `style`：修改代码格式（不影响代码运行的变动，如空格、分号缺失等）。 +- `refactor`：重构代码（既不是新增功能，也不是修改 bug 的代码变动）。 +- `perf`：优化性能。 +- `test`：增加测试或修改现有测试。 +- `ci`：修改 CI 配置文件或脚本（例如：Travis, Circle, BrowserStack, SauceLabs）。 +- `chore`：其他不修改源代码或测试文件的更改。 +- `revert`：撤销之前的提交。 From 04e67edca8cae9781a68211483ae972519a4fba4 Mon Sep 17 00:00:00 2001 From: 13812773784 Date: Sat, 16 May 2026 20:59:58 +0800 Subject: [PATCH 2/4] revert & docs(git-commit-rule): revert accidental commit and update project git commit message specification remove redundant Chinese comments, simplify structure, standardize wording and align with Conventional Commits specs --- .trae/rules/git-commit-message.md | 52 +++++-------------------------- 1 file changed, 7 insertions(+), 45 deletions(-) diff --git a/.trae/rules/git-commit-message.md b/.trae/rules/git-commit-message.md index 30ba836..324d068 100644 --- a/.trae/rules/git-commit-message.md +++ b/.trae/rules/git-commit-message.md @@ -3,22 +3,20 @@ alwaysApply: true scene: git_message --- -在此处编写规则，自定义 AI 生成提交信息的风格。 - ## 提交信息 -档案馆项目采用 Conventional Commits 规范来格式化提交信息。全部内容都使用英文。 +项目采用 Conventional Commits 规范来格式化提交信息。 ### 基本格式 -每条提交信息应遵循以下结构： +每条提交信息应遵循以下结构（只允许使用英文）： ```text -<类型>(<可选的作用域>): <描述> +<类型>(<作用域>): <描述> -[可选的正文（英文）] +[正文] -[可选的脚注（英文）] +[脚注] ``` - **类型**：必填，表示本次提交的类别（见下文“类型列表”）。 @@ -35,13 +33,7 @@ scene: git_message feat(auth): add user login endpoint ``` -2. 修复身份验证模块中未处理空值的问题： - - ```text - fix(auth): resolve unhandled null value in token validation - ``` - -3. 包含破坏性变更的提交（需在脚注中标记）： +2. 包含破坏性变更的提交（需在脚注中标记）： ```text feat(api): change response format for user details @@ -49,37 +41,7 @@ scene: git_message BREAKING CHANGE: The 'user' field in the response is now nested under 'data'. ``` -4. 关联 Issue 的提交： - - ```text - fix(ui): correct button alignment on mobile devices - - Closes #12 - ``` - -## PR 格式 - -### 描述 - -PR 的描述部分应包含足够的信息供审查者理解变更背景和具体内容。推荐使用以下模板结构： - -```markdown -## Changes -- 简要列出主要的功能变更或修复点。 -- 可以使用列表形式清晰展示。 -- 例如： - - Added login endpoint with email/password authentication and session token management - -## Related -- 关联相关的 Issue 编号，使用 `#` 符号引用。 -- 例如： - - Closes #123 - - Related to #456 -` - -## 类型列表 - -以下是项目中允许使用的提交与分支类型： +### 允许的类型列表 - `feat`：新增功能。 - `fix`：修复 bug。 From b7c1102a957f0e655f96df54cde5ac97d982e425 Mon Sep 17 00:00:00 2001 From: 13812773784 Date: Sat, 16 May 2026 21:10:09 +0800 Subject: [PATCH 3/4] revert: delete outdated git commit message rule document remove the no longer maintained trae commit lint rule file --- .trae/rules/git-commit-message.md | 56 ------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 .trae/rules/git-commit-message.md diff --git a/.trae/rules/git-commit-message.md b/.trae/rules/git-commit-message.md deleted file mode 100644 index 324d068..0000000 --- a/.trae/rules/git-commit-message.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -alwaysApply: true -scene: git_message ---- - -## 提交信息 - -项目采用 Conventional Commits 规范来格式化提交信息。 - -### 基本格式 - -每条提交信息应遵循以下结构（只允许使用英文）： - -```text -<类型>(<作用域>): <描述> - -[正文] - -[脚注] -``` - -- **类型**：必填，表示本次提交的类别（见下文“类型列表”）。 -- **作用域**：可选，用括号包裹，指明本次提交影响的代码范围（如模块名、组件名等）。 -- **描述**：必填，是对变更的简短说明，使用祈使句、现在时态，首字母小写，末尾不加句号。 -- **正文**：可选，对变更动机及与之前行为的对比进行详细说明。 -- **脚注**：可选，主要用于关联 Issue 或标记破坏性变更（BREAKING CHANGE）。 - -### 示例 - -1. 新增一个用户登录功能： - - ```text - feat(auth): add user login endpoint - ``` - -2. 包含破坏性变更的提交（需在脚注中标记）： - - ```text - feat(api): change response format for user details - - BREAKING CHANGE: The 'user' field in the response is now nested under 'data'. - ``` - -### 允许的类型列表 - -- `feat`：新增功能。 -- `fix`：修复 bug。 -- `update`: 对代码内容做出调整，而原先的代码不视为 bug（如修改前端按钮的文案） -- `docs`：仅修改文档。 -- `style`：修改代码格式（不影响代码运行的变动，如空格、分号缺失等）。 -- `refactor`：重构代码（既不是新增功能，也不是修改 bug 的代码变动）。 -- `perf`：优化性能。 -- `test`：增加测试或修改现有测试。 -- `ci`：修改 CI 配置文件或脚本（例如：Travis, Circle, BrowserStack, SauceLabs）。 -- `chore`：其他不修改源代码或测试文件的更改。 -- `revert`：撤销之前的提交。 From 5625198c1191387757346b89d5644fbf58eb78d1 Mon Sep 17 00:00:00 2001 From: 13812773784 Date: Sat, 16 May 2026 21:58:34 +0800 Subject: [PATCH 4/4] revert: revert the revert. --- .trae/rules/git-commit-message.md | 56 +++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 .trae/rules/git-commit-message.md diff --git a/.trae/rules/git-commit-message.md b/.trae/rules/git-commit-message.md new file mode 100644 index 0000000..324d068 --- /dev/null +++ b/.trae/rules/git-commit-message.md @@ -0,0 +1,56 @@ +--- +alwaysApply: true +scene: git_message +--- + +## 提交信息 + +项目采用 Conventional Commits 规范来格式化提交信息。 + +### 基本格式 + +每条提交信息应遵循以下结构（只允许使用英文）： + +```text +<类型>(<作用域>): <描述> + +[正文] + +[脚注] +``` + +- **类型**：必填，表示本次提交的类别（见下文“类型列表”）。 +- **作用域**：可选，用括号包裹，指明本次提交影响的代码范围（如模块名、组件名等）。 +- **描述**：必填，是对变更的简短说明，使用祈使句、现在时态，首字母小写，末尾不加句号。 +- **正文**：可选，对变更动机及与之前行为的对比进行详细说明。 +- **脚注**：可选，主要用于关联 Issue 或标记破坏性变更（BREAKING CHANGE）。 + +### 示例 + +1. 新增一个用户登录功能： + + ```text + feat(auth): add user login endpoint + ``` + +2. 包含破坏性变更的提交（需在脚注中标记）： + + ```text + feat(api): change response format for user details + + BREAKING CHANGE: The 'user' field in the response is now nested under 'data'. + ``` + +### 允许的类型列表 + +- `feat`：新增功能。 +- `fix`：修复 bug。 +- `update`: 对代码内容做出调整，而原先的代码不视为 bug（如修改前端按钮的文案） +- `docs`：仅修改文档。 +- `style`：修改代码格式（不影响代码运行的变动，如空格、分号缺失等）。 +- `refactor`：重构代码（既不是新增功能，也不是修改 bug 的代码变动）。 +- `perf`：优化性能。 +- `test`：增加测试或修改现有测试。 +- `ci`：修改 CI 配置文件或脚本（例如：Travis, Circle, BrowserStack, SauceLabs）。 +- `chore`：其他不修改源代码或测试文件的更改。 +- `revert`：撤销之前的提交。