撰写提交信息

相关信息

本规范于 2026 年 4 月 17 日 制定，5 月 11 日新增规范。

5 月 11 日新增：提交信息需标明所属分支

当仓库存在多个长期维护分支（例如 main 与 dev）时（例如本仓库），为避免误提交、误部署或混淆 commit 所属环境，提交信息需在开头标明所属分支，并使用英文中括号包裹。

例如：

在导航栏中，将“图标资源”迁移至“我的爱好”

style: 在导航栏中，将“图标资源”迁移至“我的爱好”

[dev] style: 在导航栏中，将“图标资源”迁移至“我的爱好”

自从 2026 年 4 月 17 日以来，本人使用新版的提交信息。具体规范如下表所示。

类型	用途
feat	新功能
fix	修复
docs	文档
style	样式（不影响逻辑）
refactor	重构
ci	CI/CD
revert	回退更改 [1]
chore	其它项目

错误提交信息

1. 新增 example 页面（path/to/example）
2. 修复 check.yml 中的 Node.js 版本问题
3. 移除自定义背景色

正确提交信息

1. docs: 新增 example 页面（path/to/example）
2. ci: 修复 check.yml 中的 Node.js 版本问题
3. style: 移除自定义背景色

---

1. 示例用法：revert: 回退更改（abcd123）。其中，abcd123 为短 commit hash。 ↩︎