提交信息
步骤
- 运行
git diff --staged 查看将要提交的内容。如果没有暂存的更改，则说明情况并询问是否要暂存所有文件 (git add -A) 或特定文件。切勿未询问即提交未暂存的工作。
- 运行
git log --oneline -15 并匹配你看到的风格：约定式提交 (feat(api): …)、工单前缀 (ABC-123 …) 或普通句子。如果没有明确的约定，则使用普通的祈使句。
- 如果暂存的更改包含几个不相关的改动，建议先将其拆分为单独的提交，再统一编写一个提交信息。
格式
<摘要行，祈使语气，最多约72个字符，末尾无句号>
<正文：解释为何进行更改以及审阅者无法从 diff 中看到的内容。
每行72个字符。对于微小更改可省略正文。>
<跟踪信息：Fixes #123, Co-authored-by: …, BREAKING CHANGE: …>
- 祈使语气："Add retry to upload"，而不是 "Added" 或 "Adds"。
- 摘要说明对用户或代码库来说更改了什么，而非涉及了哪些文件。
- 正文解释原因：bug、约束、被拒绝的替代方案。diff 已经展示了内容。
- 使用约定式提交时，诚实地选择类型：
feat（新功能）、fix（缺陷修复）、refactor（行为不变）、perf、docs、test、build、ci、chore。破坏性变更用 ! 标记并添加 BREAKING CHANGE: 跟踪信息。
示例
fix(auth): refresh the token before it expires, not after
Requests made in the last 30 seconds of a token's life failed with 401
because the refresh only ran on the first failure. Refresh when less than
60 seconds remain instead.
Fixes #482
Remove unused CSV export endpoint