以下git提交建議的文字描述來自alibaba的開源項(xiàng)目egg.js锅锨,git-commit規(guī)范;符號部分來自github里部分項(xiàng)目的emoji表情提交建議。
一斜筐、文字規(guī)范
commit一共由五部分組成,具體內(nèi)容如下蛀缝。
(1)type
提交 commit 的類型顷链,包括以下幾種
- feat: 新功能
- fix: 修復(fù)問題
- docs: 修改文檔
- style: 修改代碼格式,不影響代碼邏輯
- refactor: 重構(gòu)代碼屈梁,理論上不影響現(xiàn)有功能
- perf: 提升性能
- test: 增加修改測試用例
- chore: 修改工具相關(guān)(包括但不限于文檔嗤练、代碼生成等)
- deps: 升級依賴
(2)scope
修改文件的范圍(包括但不限于 doc, middleware, core, config, plugin)
(3)subject
用一句話清楚的描述這次提交做了什么
(4)body
補(bǔ)充 subject,適當(dāng)增加原因在讶、目的等相關(guān)因素煞抬,也可不寫。
(5)footer
- 當(dāng)有非兼容修改(Breaking Change)時(shí)必須在這里描述清楚
- 關(guān)聯(lián)相關(guān) issue构哺,如
Closes #1, Closes #2, #3
- 如果功能點(diǎn)有新增或修改的革答,還需要關(guān)聯(lián)文檔
doc
二、emoji規(guī)范
注:以下emoji表情在git提交時(shí)已經(jīng)完全支持曙强,哪怕下面的表情顯示不完整也不用慌蝗碎,可以直接在git-submit里使用。
emoji | emoji代碼 | commit說明 |
---|---|---|
?? (調(diào)色板) | :art: | 改進(jìn)代碼結(jié)構(gòu)/代碼格式 |
?? (閃電) | :zap: | 提升性能 |
?? (賽馬) | :racehorse: | 提升性能 |
?? (火焰) | :fire: | 移除代碼或文件 |
?? (bug) | :bug: | 修復(fù) bug |
?? (急救車) | :ambulance: | 重要補(bǔ)丁 |
? (火花) | :sparkles: | 引入新功能 |
?? (鉛筆) | :pencil: | 撰寫文檔 |
?? (火箭) | :rocket: | 部署功能 |
?? (口紅) | :lipstick: | 更新 UI 和樣式文件 |
?? (慶祝) | :tada: | 初次提交 |
? (白色復(fù)選框) | :white_check_mark: | 增加測試 |
?? (鎖) | :lock: | 修復(fù)安全問題 |
?? (蘋果) | :apple: | 修復(fù) macOS 下的問題 |
?? (企鵝) | :penguin: | 修復(fù) Linux 下的問題 |
?? (旗幟) | :checked_flag: | 修復(fù) Windows 下的問題 |
?? (書簽) | :bookmark: | 發(fā)行/版本標(biāo)簽 |
?? (警車燈) | :rotating_light: | 移除 linter 警告 |
?? (施工) | :construction: | 工作進(jìn)行中 |
?? (綠心) | :green_heart: | 修復(fù) CI 構(gòu)建問題 |
?? (下降箭頭) | :arrow_down: | 降級依賴 |
?? (上升箭頭) | :arrow_up: | 升級依賴 |
?? (工人) | :construction_worker: | 添加 CI 構(gòu)建系統(tǒng) |
?? (上升趨勢圖) | :chart_with_upwards_trend: | 添加分析或跟蹤代碼 |
?? (錘子) | :hammer: | 重大重構(gòu) |
? (減號) | :heavy_minus_sign: | 減少一個(gè)依賴 |
?? (鯨魚) | :whale: | 相關(guān)工作 |
? (加號) | :heavy_plus_sign: | 增加一個(gè)依賴 |
?? (扳手) | :wrench: | 修改配置文件 |
?? (地球) | :globe_with_meridians: | 國際化與本地化 |
?? (鉛筆) | :pencil2: | 修復(fù) typo |