Git提交注释规范

Git提交注释规范

平时工作经常需要提交代码，本篇文章记录下提交代码注释的规范。

与JIRA结合提交注释规范

<ISSUE_KEY> #<CMD> <optional CMD_PARAMETERS>

反例1：

debugging

反例2：

I've added a delete route to the accounts controller

正例1：

JRA-123 #resolve

正例2：

JRA-123 #Enable Logging Globally

正例3：

JRA-123 #Add Account Delete Route,Needed for account deletion workflow on frontend

参考文献：

1. Github for Jira: How to Setup Smart Commits for Software Releases
2. Git Commit