前端編碼規範之：Git使用規範

1. 前端編碼規範之：Git使用規範
2. 前端編碼規範之：樣式（scss）編碼規範
3. 前端編碼規範之：HTML結構規範
4. 前端編碼規範之：Vue最佳實踐
5. 前端編碼規範之：Javascript編碼規範

整理了下，基本的git操做能夠本身新建一個github的repo熟悉下。

Git版本規範

分支

• master分支爲主分支(保護分支)，不能直接在master上進行修改代碼和提交
• develop分支爲測試分支，因此開發完成須要提交測試的功能合併到該分支
• feature分支爲開發分支，你們根據不一樣需求建立獨立的功能分支，開發完成後合併到develop分支，merge完成就能夠刪除
• fix分支爲bug修復分支，須要根據實際狀況對已發佈的版本進行漏洞修復，merge完成就能夠刪除

Tag

採用三段式，v版本.里程碑.序號，如v1.2.1

• 架構升級或架構重大調整，修改第2位
• 新功能上線或者模塊大的調整，修改第2位
• bug修復上線，修改第3位

changelog

版本正式發佈後，須要生產changelog文檔，便於後續問題追溯

commit message規範

Commit message通常包括三部分：Header、Body和Footer

Header

type(scope):subject。

• type：用於說明commit的類別，規定爲以下幾種

  • feat：新增功能；
  • fix：修復bug；
  • docs：修改文檔；
  • refactor：代碼重構，未新增任何功能和修復任何bug；
  • build：改變構建流程，新增依賴庫、工具等（例如webpack修改）；
  • style：僅僅修改了空格、縮進等，不改變代碼邏輯；
  • perf：改善性能和體現的修改；
  • chore：非src和test的修改；
  • test：測試用例的修改；
  • ci：自動化流程配置修改；
  • revert：回滾到上一個版本；
• scope：【可選】用於說明commit的影響範圍
• subject：commit的簡要說明，儘可能簡短

Body

• 對本次commit的詳細描述，可分多行

尾部（Footer）

• 不兼容變更：須要描述相關信息
• 關閉指定Issue：輸入Issue信息

Git Commit 優勢

• 統一團隊Git Commit標準，便於後續代碼review、版本發佈、自動化生成change log
• 能夠提供更多更有效的歷史信息，方便快速預覽以及配合cherry-pick快速合併代碼
• 團隊其餘成員進行git blame等操做能夠快速明白代碼用意

原文：Git Commit 規範以及emoji 使用指南

git commit emoji 使用指南

============================
來源：git commit emoji 使用指南

目錄

• commit 格式
• emoji 指南
• 如何在命令行中顯示 emoji

• 參考

  • git commit emoji
  • write a good commit message

執行 git commit 時使用 emoji 爲本次提交打上一個 "標籤", 使得這次 commit 的主要工做得以凸現，也可以使得其在整個提交歷史中易於區分與查找。

截取的 gitmoji 快照:

https://github.com/liuchengxu...

commit 格式

git commit 時，提交信息遵循如下格式：

:emoji1: :emoji2: 不超過 50 個字的摘要，首字母大寫，使用祈使語氣，句末不要加句號

提交信息主體

引用相關 issue 或 PR 編號 <#110>

初次提交示例：

git commit -m ":tada: Initialize Repo"

emoji 指南

emoji	emoji 代碼	commit 說明
(慶祝)	:tada:	初次提交
(火花)	:sparkles:	引入新功能
(書籤)	:bookmark:	發行/版本標籤
(bug)	:bug:	修復 bug
(急救車)	:ambulance:	重要補丁
(地球)	:globe_with_meridians:	國際化與本地化
(口紅)	:lipstick:	更新 UI 和樣式文件
(警車燈)	:rotating_light:	移除 linter 警告
(扳手)	:wrench:	修改配置文件
(加號)	:heavy_plus_sign:	增長一個依賴
(減號)	:heavy_minus_sign:	減小一個依賴
(上升箭頭)	:arrow_up:	升級依賴
(降低箭頭)	:arrow_down:	降級依賴
(閃電) (賽馬)	:zap: :racehorse:	提高性能
(上升趨勢圖)	:chart_with_upwards_trend:	添加分析或跟蹤代碼
(火箭)	:rocket:	部署功能
(白色複選框)	:white_check_mark:	增長測試
(備忘錄)	:memo:	撰寫文檔
(錘子)	:hammer:	重大重構
(調色板)	:art:	改進代碼結構/代碼格式
(火焰)	:fire:	移除代碼或文件
(鉛筆)	:pencil2:	修復 typo
(施工)	:construction:	工做進行中
(工人)	:construction_worker:	添加 CI 構建系統
(綠心)	:green_heart:	修復 CI 構建問題
(鎖)	:lock:	修復安全問題
(鯨魚)	:whale:	Docker 相關工做
(蘋果)	:apple:	修復 macOS 下的問題
(企鵝)	:penguin:	修復 Linux 下的問題
(旗幟)	:checked_flag:	修復 Windows 下的問題

如何在命令行中顯示 emoji

默認狀況下，在命令行中並不會顯示出 emoji, 僅顯示 emoji 代碼。不過可使用 emojify 使得在命令行也可顯示 emoji, 它是一個 shell 腳本，安裝與使用都很簡單，在 這裏 查看如何安裝與使用。

https://github.com/liuchengxu...

參考

git commit emoji

• gitmoji
• emoji-cheat-sheet
• styleguide-git-commit-message
• atom git commit messages guide
• An emoji guide for your commit messages
• 程序員提交代碼的 emoji 指南——原來表情文字不能亂用

write a good commit message

• A Note About Git Commit Messages
• How to write a Git Commit Message (2014)
• how to write a good git commit message
• 5 Useful Tips For A Better Commit Message
• Udacity Git Commit Message Style Guide
• How to commit a change with both 「message」 and 「description」 from the command line?