提交信息和版本号

约定式提交

最近想给一个开源项目添加一些功能,fork之后提交到自己仓库被拒了,查看了下使用了Commitlint,提交信息不符合规范。

继续探索后找到了这个文档,这是一份约定俗成的提交规范,详细解释了什么类型的提交应该写什么样的提交信息。

现在公司的代码发布有特殊的方式,有两个仓库分别是dev仓库和prod仓库,个人提交代码流程如下:

  1. 在jira建立ticket,修改release日期为今天;
  2. 修改代码并提交(commit),按照jira ticket的编号给代码打tag;
  3. push 这个tag到dev仓库,拿到一个commit链接;
  4. 把commit链接贴到jira ticket中,发给同事进行code review;
  5. 同事评估代码,然后在jira ticket中点code signoff;
  6. 去一个特定的代码发布页面,把tag名字写进去,jira ticket的链接会自动填写,点击relase按钮;
  7. release流程会自动把dev仓库的这个tag下的改动,自动合并到prod仓库。

这个流程中只要求了tag名字的规范,并没有要求commit信息如何填写,所以每个人都写的很随意。

通过这个文档学习一下commit规范,规范自己的编码习惯。

语义化版本

公司使用Github enterprise版本,且开发流程没有具体限制,全靠个人习惯。而我在发布新功能时候,版本号也仅仅是在原来小数点后面加1,并没有细究版本号的含义。

找到了一份语义化版本的文档,详细阐述了X.Y.Z的版本号中,什么时候要修改哪一位,每一位的意义是什么。