From 0d07b9f4ce886fc1343c02e536a6b17a9b41cd8a Mon Sep 17 00:00:00 2001 From: Yuyi-Oak <1722157266@qq.com> Date: Wed, 15 Jul 2026 21:28:22 +0800 Subject: [PATCH] =?UTF-8?q?docs(docs):=20=E8=AE=B0=E5=BD=95=E6=8F=90?= =?UTF-8?q?=E4=BA=A4=E4=BF=A1=E6=81=AF=20scope=20=E8=A7=84=E5=88=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 要求提交标题统一使用 type(scope): 中文说明,并在开发指南和贡献指南中补充示例。 --- CONTRIBUTING.md | 15 +++++++++------ docs/guides/development.md | 19 +++++++++++-------- 2 files changed, 20 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06fd662..13faf6d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,15 +20,18 @@ 提交信息使用 Conventional Commits: -- `feat:` 新功能 -- `fix:` 修复 bug -- `docs:` 文档更新 -- `test:` 测试或 fixture 更新 -- `refactor:` 不改变行为的重构 -- `chore:` 构建、依赖或辅助工具调整 +- 必须使用 `type(scope): 中文说明` 格式。 +- `type` 使用 `feat`、`fix`、`docs`、`test`、`refactor`、`chore` 等 Conventional Commits 类型。 +- `scope` 必须写具体模块或文档域,例如 `ffi`、`docs`、`cli`、`cas`、`official-sync`。 提交说明默认使用简体中文。代码标识符和协议字段仍使用英文。 +示例: + +- `feat(cli): 添加 doctor 命令骨架` +- `fix(docs): 修正官方同步运行说明` +- `refactor(ffi): 降级 FFI 为可选兼容层` + ## 验证要求 基础验证命令见 `docs/guides/development.md`。常用最低门禁: diff --git a/docs/guides/development.md b/docs/guides/development.md index b8c5b25..130d5c6 100644 --- a/docs/guides/development.md +++ b/docs/guides/development.md @@ -73,17 +73,20 @@ make fmt ```bash git add . -git commit -m "feat: 添加新功能" +git commit -m "feat(cli): 添加 doctor 命令骨架" ``` 提交信息遵循 [Conventional Commits](https://www.conventionalcommits.org/) 规范: -- `feat:` 新功能 -- `fix:` 修复 bug -- `docs:` 文档更新 -- `style:` 代码格式(不影响功能) -- `refactor:` 重构 -- `test:` 测试相关 -- `chore:` 构建工具或辅助工具 +- 必须使用 `type(scope): 中文说明` 格式。 +- `type` 使用 `feat`、`fix`、`docs`、`style`、`refactor`、`test`、`chore` 等 Conventional Commits 类型。 +- `scope` 必须写具体模块或文档域,例如 `ffi`、`docs`、`cli`、`cas`、`official-sync`。 +- 提交标题和正文默认使用简体中文;代码标识符、协议字段和命令参数仍保持英文。 + +示例: + +- `feat(cli): 添加 doctor 命令骨架` +- `fix(docs): 修正官方同步运行说明` +- `refactor(ffi): 降级 FFI 为可选兼容层` ### 4. 推送和 PR