分支
- master分支為主分支(保護分支),不能直接在master上進行修改代碼或提交,通過MR(merge Request)或者PR(pull Request)的方式進行提交。
- preview分支為預發分支, 所有測試完成需要上線的功能合并到該分支
- develop、 test分支為測試分支,所有開發完成需要提交測試的功能合并到該分支
- feature/xxx分支為功能開發分支,根據不同需求創建獨立的功能分支,開發完成后合并到develop或test分支
- hotfix分支為bug修復分支,需要根據實際情況對已發布的版本進行漏洞修復
Tag
采用三段式,v版本.里程碑.序號,例如v1.0.0
- 架構升級或架構重大調整,修改第1位
- 新功能上線或者模塊大的調整,修改第2位
- bug修復上線,修改第3位
Commit message的格式
每次提交,Commit message 都包括三個部分:header,body 和 footer。
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
其中,Header 是必需的,Body 和 Footer 可以省略。
不管是哪一個部分,任何一行都不得超過72個字符(或100個字符)。這是為了避免自動換行影響美觀。
Header
Header部分只有一行,包括三個字段:type(必需)、scope(可選)和subject(必需)。
- type
type用于說明 commit 的類別,只允許使用下面7個標識。
- feat:新功能(feature)
- fix:修補bug
- docs:文檔(documentation)
- style: 格式(不影響代碼運行的變動)
- refactor:重構(即不是新增功能,也不是修改bug的代碼變動)
- test:增加測試
- chore:構建過程或輔助工具的變動
如果type為feat和fix,則該 commit 將肯定出現在 Change log 之中。其他情況(docs、chore、style、refactor、test)由你決定,要不要放入 Change log,建議是不要。- scope
scope用于說明 commit 影響的范圍,比如數據層、控制層、視圖層等等,視項目不同而不同。 - subject
subject是 commit 目的的簡短描述,不超過50個字符。
- 以動詞開頭,使用第一人稱現在時,比如change,而不是changed或changes
- 第一個字母小寫
- 結尾不加句號(.)
- scope
Body
Body 部分是對本次 commit 的詳細描述,可以分成多行。下面是一個范例。
More detailed explanatory text, if necessary. Wrap it to
about 72 characters or so.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Use a hanging indent
有兩個注意點。
(1)使用第一人稱現在時,比如使用change而不是changed或changes。
(2)應該說明代碼變動的動機,以及與以前行為的對比。
Footer
Footer 部分只用于兩種情況。
- 不兼容變動
如果當前代碼與上一個版本不兼容,則 Footer 部分以BREAKING CHANGE開頭,后面是對變動的描述、以及變動理由和遷移方法。
BREAKING CHANGE: isolate scope bindings definition has changed.
To migrate the code follow the example below:
Before:
scope: {
myAttr: 'attribute',
}
After:
scope: {
myAttr: '@',
}
The removed `inject` wasn't generaly useful for directives so there should be no code using it
- 關閉 Issue
如果當前 commit 針對某個issue,那么可以在 Footer 部分關閉這個 issue 。
Closes #234
Revert
還有一種特殊情況,如果當前 commit 用于撤銷以前的 commit,則必須以revert:開頭,后面跟著被撤銷 Commit 的 Header。
revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Body部分的格式是固定的,必須寫成This reverts commit <hash>.,其中的hash是被撤銷 commit 的 SHA 標識符。
如果當前 commit 與被撤銷的 commit,在同一個發布(release)里面,那么它們都不會出現在 Change log 里面。如果兩者在不同的發布,那么當前 commit,會出現在 Change log 的Reverts小標題下面。
Commitizen
Commitizen是一個撰寫合格 Commit message 的工具。
安裝命令如下。
$ npm install -g commitizen
然后,在項目目錄里,運行下面的命令,使其支持 Angular 的 Commit message 格式。
$ commitizen init cz-conventional-changelog --save --save-exact
以后,凡是用到git commit命令,一律改為使用git cz。這時,就會出現選項,用來生成符合格式的 Commit message。
validate-commit-msg
validate-commit-msg 用于檢查 Node 項目的 Commit message 是否符合格式。
它的安裝是手動的。首先,拷貝下面這個JS文件,放入你的代碼庫。文件名可以取為validate-commit-msg.js。
接著,把這個腳本加入 Git 的 hook。下面是在package.json里面使用 ghooks,把這個腳本加為commit-msg時運行。
"config": {
"ghooks": {
"commit-msg": "./validate-commit-msg.js"
}
}
然后,每次git commit的時候,這個腳本就會自動檢查 Commit message 是否合格。如果不合格,就會報錯。
$ git add -A
$ git commit -m "edit markdown"
INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" ! was: edit markdown
生成 Change log
如果你的所有 Commit 都符合 Angular 格式,那么發布新版本時, Change log 就可以用腳本自動生成
生成的文檔包括以下三個部分。
- New features
- Bug fixes
- Breaking changes.
每個部分都會羅列相關的 commit ,并且有指向這些 commit 的鏈接。當然,生成的文檔允許手動修改,所以發布前,你還可以添加其他內容。
conventional-changelog 就是生成 Change log 的工具,運行下面的命令即可。
$ npm install -g conventional-changelog
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -w
上面命令不會覆蓋以前的 Change log,只會在CHANGELOG.md的頭部加上自從上次發布以來的變動。
如果你想生成所有發布的 Change log,要改為運行下面的命令。
$ conventional-changelog -p angular -i CHANGELOG.md -w -r 0
為了方便使用,可以將其寫入package.json的scripts字段。
{
"scripts": {
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"
}
}
以后,直接運行下面的命令即可。
$ npm run changelog
git commit中使用emoji
emoji規范格式
git commit 時,提交信息遵循以下格式:
:emoji1: :emoji2: 主題
提交信息主體
Ref <###>
初次提交示例:
git commit -m ":tada: Initialize Repo"
emoji指南
emoji | emoji代碼 | Commit說明 |
---|---|---|
?? (調色板) | :art: | 改進代碼結構/代碼格式 |
?? (閃電) | :zap: | 提升性能 |
?? (賽馬) | :racehorse: | 提升性能 |
?? (火焰) | :fire: | 移除代碼或文件 |
?? (bug) | :bug: | 修復 bug |
?? (急救車) | :ambulance: | 重要補丁 |
? (火花) | :sparkles: | 引入新功能 |
?? (鉛筆) | :pencil: | 撰寫文檔 |
?? (火箭) | :rocket: | 部署功能 |
?? (口紅) | :lipstick: | 更新 UI 和樣式文件 |
?? (慶祝) | :tada: | 初次提交 |
? (白色復選框) | :white_check_mark: | 增加測試 |
?? (鎖) | :lock: | 修復安全問題 |
?? (蘋果) | :apple: | 修復 macOS 下的問題 |
?? (企鵝) | :penguin: | 修復 Linux 下的問題 |
?? (旗幟) | :checked_flag: | 修復 Windows 下的問題 |
?? (書簽) | :bookmark: | 發行/版本標簽 |
?? (警車燈) | :rotating_light: | 移除 linter警告 |
?? (施工) | :construction: | 工作進行中 |
?? (綠心) | :green_heart: | 修復 CI 構建問題 |
?? (下降箭頭) | :arrow_down: | 降級依賴 |
?? (上升箭頭) | :arrow_up: | 升級依賴 |
?? (工人) | :construction_worker: | 添加 CI 構建系統 |
?? (上升趨勢圖) | :chart_with_upwards_trend: | 添加分析或跟蹤代碼 |
?? (錘子) | :hammer: | 重大重構 |
? (減號) | :heavy_minus_sign: | 減少一個依賴 |
?? (鯨魚) | :whale: | Docker 相關工作 |
? (加號) | :heavy_plus_sign: | 增加一個依賴 |
?? (扳手) | :wrench: | 修改配置文件 |
?? (地球) | :globe_with_meridians: | 國際化與本地化 |
?? (鉛筆) | :pencil2: | 修復 typo |