开发实践
Commit Message
代码提交 Commit Message 在开源社区项目中相比个人项目尤为重要,我们需要一个规范的格式来区分每次提交的功能,这也使得 CHANGELOG 赏心悦目。 同时也有一些 Release 机器人通过 Commit Message 来自动生成发版日志。
我自身过去经常使用 gitmoji 这一规范,即使用 emoji 作为每次 commit message 的开头,作为示意。 它很可爱,对于个人项目来说也无伤大雅而反而显得更为别致,但是对于与他人合作的大型项目来说,这可能就不大合适了。
因此,工作中其实更为推荐广为流行的 Angular Commit Message 规范,这也是众多开源项目使用的标准格式。
更多内容可参见下文给出的链接,不再赘述。
Angular
- Commit Message Format | angular | GitHub
- AngularJS Git Commit Message Conventions | Google Docs
- Angular 提交信息规范: 大致是上文的翻译
相关工具
- commitlint | GitHub: 对提交的 commit 信息进行检查
- conventional-github-releaser | GitHub: 根据 Git 信息在 GitHub 上 Release,一个示例 .github/workflows/release.yml | antfu/ni
- cz-cli: 使用 cli 交互命令提交符合规范的 commit message
Gitmoji
- gitmoji: An emoji guide for your commit messages
- gitmoji | GitHub
- gitmoji-cli | GitHub: 通过 cli 来生成规范的 gitmoji message