zhoujie/autoPaper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(git-commit): 要求 commit message 正文用中文书写

Browse Source 
用户明确要求这个仓库的提交信息用中文;type前缀(feat/fix等)和scope仍保留
英文,分别对应社区通用约定和目录名本身。

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
zhoujie 2026-07-21 02:34:58 -10:00
parent 26ca0e6ab2
commit 8cf3aff4e2
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.claude/skills/git-commit/SKILL.md
View File

@ -33,12 +33,17 @@ message省的是未来翻`git log`时重新读一遍diff的时间。这个技能
### 第三步:生成 commit message ### 第三步:生成 commit message
采用 Conventional Commits 格式(除非第一步发现这个仓库明显用别的风格,这种情况下跟随仓库风格): **message 正文(subject/body)用中文写**——除非第一步发现这个仓库历史上明显
是用英文写(且不是本技能自己产生的commit),这种情况下跟随仓库现有语言。
`type`前缀本身仍用英文标准词(`feat`/`fix`等,这是社区通用约定,不翻译),
`scope`用原始的模块/skill名(通常本身就是英文目录名,不需要翻译)。
格式采用 Conventional Commits:
``` ```
<type>(<scope>): <subject> <type>(<scope>): <中文subject>
<body — 可选,只在"为什么"不是一眼能看出来的时候写> <中文body — 可选,只在"为什么"不是一眼能看出来的时候写>
``` ```
- `type` 从改动的实际性质里选,不要凭感觉:`feat`(新功能)、`fix`(修bug)、 - `type` 从改动的实际性质里选,不要凭感觉:`feat`(新功能)、`fix`(修bug)、
@ -48,10 +53,10 @@ message省的是未来翻`git log`时重新读一遍diff的时间。这个技能
考虑拆成多个提交,而不是硬凑一个笼统的type。 考虑拆成多个提交,而不是硬凑一个笼统的type。
- `scope` 可选,涉及单一模块/skill时加上(比如`literature-search-verify`、 - `scope` 可选,涉及单一模块/skill时加上(比如`literature-search-verify`、
`paper-writing-grounded`),改动横跨全仓库时省略。 `paper-writing-grounded`),改动横跨全仓库时省略。
- `subject` 祈使语气、不超过~70字符、不以句号结尾,说清楚这次改动做了什么, - `subject` 祈使/陈述语气均可、不超过~35个汉字、不以句号结尾,说清楚这次改动
但真正的价值在于讲清楚**为什么**要这么改——如果"为什么"不是从改动本身能 做了什么,但真正的价值在于讲清楚**为什么**要这么改——如果"为什么"不是从
一眼看出来的(比如修了一个不明显的bug、调整了一个非默认行为),写进body里, 改动本身能一眼看出来的(比如修了一个不明显的bug、调整了一个非默认行为),
不要只重复diff里已经能看到的内容。 写进body里,不要只重复diff里已经能看到的内容。
- 不要在message里提及和这次改动无关的历史背景或猜测性动机。 - 不要在message里提及和这次改动无关的历史背景或猜测性动机。
### 第四步:暂存并提交 ### 第四步:暂存并提交