提交信息遵循 Conventional Commits:<type>(<scope>): <subject>。
- type:
feat/fix/docs/refactor/test/chore/ci/revert - scope:
slack-hook/device-link/plugin/model-access/docs/repo - subject:祈使句、结尾不加句号;type/scope 用英文,subject 中英文皆可
- 破坏性变更:type 后加
!(如feat(device-link)!: ...),正文写BREAKING CHANGE:说明,且同一提交内必须 bump 对应协议的版本号(见 CONTRIBUTING.md 「协议演进纪律」第 6 条)
仓库根提供了提交模板,clone 后执行一次即可在 git commit 时自动带出格式提示:
git config commit.template .gitmessage