Git代碼提交規範

1、代碼提交規範化的目的

• 爲了部門提交代碼信息格式規範化
• 爲了更好的追溯代碼、篩選
• 爲了更加快速的定位提交代碼所涉及的範圍和實現功能
• 爲了後續代碼的Review、自動生成ChangeLog

2、代碼提交信息規範模板

本模板修改自《Angular代碼提交規範》,分爲Header、Body兩大塊內容，去除Footer，這一部分咱們並不經常使用

[Bug修復](4.27.10):http://jira.xyz.cn/browse/XYZDEV-9043

緣由分析:需求內容不完整或錯誤
複製代碼

Header

一、提交類型

• 【新增功能】-【新的功能點、新的需求】
• 【Bug修復】-【修復的Bug:現網發散Bug、測試階段的Bug、驗收階段的Bug】
• 【文檔修改】-【只是修改了文檔:註釋、README.md等】.
• 【樣式修改】-【不影響代碼功能的修改:CSS樣式、代碼格式化等】
• 【代碼重構】-【代碼更改既不修復錯誤也不添加功能】
• 【性能優化】-【代碼更改能夠提升性能】
• 【測試代碼】-【添加缺失測試或更正現有測試】
• 【編譯代碼】-【影響構建系統或外部依賴項的更改:build.gradle、package.json、Podfile等】
• 【持續集成】-【咱們的CI配置文件和腳本的更改:Jenkinsfile等】
• 【回退更改】-【代碼回退提交更改】
• 【其餘提交】-【除以上全部類型以外的提交更改】

二、涉及範圍

這裏咱們以版本號劃分範圍，這次提交代碼所涉及到的發佈版本。若是涉及多個版本則以4.14.10~4.27.10表示

三、簡要描述

（1）若是提交類型是【Bug修復】,則簡要描述直接填寫Bug的JIRA或者Sentry連接 （2）若是提交類型是【新增功能】,則簡要描述填寫對應需求的JIRA連接或需求的詳細描述，如需求過於龐大，則應拆分紅小的功能點提交代碼，便於Review人員審覈,也有利於Bug的回溯。 （3）若是提交類型是其餘類型，則簡要描述根據你的理解，儘可能用簡短的文字描述出這次代碼提交的目的

Body

一、詳細描述

這邊的詳細描述，力爭語句表達清晰這次提交的代碼具體涉及的功能點、修改、緣由分析等，如功能點不少則應使用序號列出代碼所涉及的功能點。以下所示

1、安心管選擇對象頁修改
2、家庭成員、車輛、房屋的列表、編輯、新增頁修改
3、安心管關係對象重定義
複製代碼

3、IDEA 插件集成

爲了規範成員的提交代碼信息，我新寫了一個IDEA插件來幫助快速生成代碼提交信息模板。

IDEA插件集成

目前已經提交IDEA插件市場，搜索Commit-Message-Create或者使用下面提供的Jar包，自行百度集成。

連接：pan.baidu.com/s/1fpBMfbvy… 提取碼：82t1