HbGitHubCommitMessage

GitHub Commit message 用语规范 | 安人集团

在安人集团工作，往 GitHub 里更新内容是家常便饭。但一些新人可能不清楚该如何写 commit message 更妥， 便随意写写、能 commit 就好，比如只有 add、update ，甚至有些直接写自己名字的缩写。

这么做当下是省事儿了，但未来如果想回去查看过往版本，面对一溜不明所以的标记，那真是灾难呐。

所以，为了你和你的同伴都能愉快玩耍，请认真对待 commit message ：

1. 请写有区分度的 commit message 。如果不知道如何用英文表达，直接写中文也好过乱写一气。
2. 如果能用英文表达那是再好不过。根据团队里常见情境，建议你根据不同修改类型写 commit message：
   • fix typo / link / image / name of docs ：修正一些内容，比如排版或格式问题，修正链接、图片，修改文档名等
   • revise wording of <name of your docs> ：较大范围地修改某文档内容
   • refactor the <name of your docs> ： 调整了某个文档的结构
   • add <summary of your content> ：增加某些内容，注意简述是什么内容
   • create <name of your docs> ：创建某个文档
   • init(short for initialization) ： 一般用于初始化某个仓库时
   • ……

如果不是内容协作，而是软件开发场景，那 commit message 就不能如此俭省啦，此时最好按这个规范：Commit message 和 Change log 编写指南 - 阮一峰的网络日志。

CHANGELOG

• 180425 闪闪创建