https://github.com/septwong/git-commit-message
Git commit message and git emoji
https://github.com/septwong/git-commit-message
git-commit git-emoji
Last synced: 3 months ago
JSON representation
Git commit message and git emoji
- Host: GitHub
- URL: https://github.com/septwong/git-commit-message
- Owner: septwong
- License: mit
- Created: 2024-11-01T03:28:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-10T08:24:29.000Z (about 1 year ago)
- Last Synced: 2025-01-15T04:24:28.395Z (12 months ago)
- Topics: git-commit, git-emoji
- Homepage:
- Size: 23.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Commit Message
> Git 提交规范
- [Git 指令](./docs/git-command.md)
- [清理Github仓库中敏感信息](./docs/clean_sensitive_file.md)
- [Angular Commit Message Conventions](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)
- [ConventionalCommits.org](https://www.conventionalcommits.org/zh-hans)
## Git commit
Commit message 包括三个部分：Header，Body 和 Footer。
Header 的格式比较特殊，包括三个字段：type（必需）、scope（可选）和subject（必需）。
```text
():
```
> Header 是必需的，Body 和 Footer 可以省略。
```text
():
│ │ │
│ │ └─⫸ 主要描述，尽量简短
│ │
│ └─⫸ Commit Scope(可选): common | 业务模块[挂号 就诊人 用户子系统] 等等
│
└─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|style|test
```
> git commit - m 'feat(common): util 中加入节流函数'
> `-m` 参数 : 指定 commit message
*示例：*
```text
docs(changelog): update changelog to beta.5
```
```text
fix(release): need to depend on latest rxjs and zone.js
The version in our package.json gets copied to the one we publish, and users need the latest of these.
```
### type
|#|字符|文案|备注|颜色|规范|
|:---:|:---:|:---|:---|:---:|:---:|
|1|`build`|构建|对构建系统或外部依赖项进行了更改（示例范围：gulp、broccoli、npm）|`#d93f0b`|Angular|
|2|`ci`|持续集成|对 CI 配置文件和脚本进行了更改（示例范围：Travis、Circle、BrowserStack、SauceLabs）|`#c5def5`|Angular|
|3|`docs`|文档注释|对文档进行了修改|`#0075ca`|Angular|
|4|`feat`|功能|增加新的特征|`#a2eeef`|Angular|
|5|`fix`|修复|修复 BUG|`#d73a4a`|Angular|
|6|`perf`|性能|提高性能的代码更改|`#5319e7`|Angular|
|7|`refactor`|重构|既不修复错误也不添加功能的代码更改|`#006b75`|Angular|
|8|`style`|样式|不影响代码含义的更改（空格、格式、缺少分号等）|`#5c879d`|Angular|
|9|`test`|测试|添加缺失的测试或更正现有的测试|`#fbca04`|Angular|
|-|-|-|-|-|-|-|
|-|`chore`|琐事|依赖项/修改脚手架配置等|`#424242`|-|
|-|`revert`|撤销|撤消更改|`#E91E63`|-|
|-|`workflow`|工作流|工作流程改进|`#8BC34A`|-|
|-|`wip`|开发中|开发中|`#9E9E9E`|-|
|-|`types`|类型定义|类型定义|`#CE93D8`|-|
|-|`release`|发布|发布版本|`#2ECC71`|-|
|-|`opt`|优化|优化业务代码|`#FF9800`|-|
### scope
可选: 没有统一的约定，一般提交时填写涉及的范围即可（公共模块 | 业务模块 ）
### subject
是 commit 目的的简短描述，不超过50个字符。
```md
- 以动词开头，使用第一人称现在时，比如change，而不是changed或changes
- 第一个字母小写
- 结尾不加句号（.）
```
### body
是对本次 commit 的详细描述，可以分成多行。
### footer
- 不兼容变动: `BREAKING CHANGE: something.`
- 关闭 Issue: `Closes #100, #101, #102`
## Git emoji
> git commit -m ":tada: initialize Repo"
| emoji | emoji 代码 | commit 说明 |
| ---------------------------------- | ----------------------------- | --------------- |
| :tada: (庆祝) | `:tada:` | 初次提交 |
| :new: (全新) | `:new:` | 引入新功能 |
| :bookmark: (书签) | `:bookmark:` | 发行/版本标签 |
| :bug: (bug) | `:bug:` | 修复 bug |
| :ambulance: (急救车) | `:ambulance:` | 重要补丁 |
| :globe_with_meridians: (地球) | `:globe_with_meridians:` | 国际化与本地化 |
| :lipstick: (口红) | `:lipstick:` | 更新 UI 和样式文件 |
| :clapper: (场记板) | `:clapper:` | 更新演示/示例 |
| :rotating_light: (警车灯) | `:rotating_light:` | 移除 linter 警告 |
| :wrench: (扳手) | `:wrench:` | 修改配置文件 |
| :heavy_plus_sign: (加号) | `:heavy_plus_sign:` | 增加一个依赖 |
| :heavy_minus_sign: (减号) | `:heavy_minus_sign:` | 减少一个依赖 |
| :arrow_up: (上升箭头) | `:arrow_up:` | 升级依赖 |
| :arrow_down: (下降箭头) | `:arrow_down:` | 降级依赖 |
| :zap: (闪电)
:racehorse: (赛马) | `:zap:`
`:racehorse:` | 提升性能 |
| :chart_with_upwards_trend: (上升趋势图) | `:chart_with_upwards_trend:` | 添加分析或跟踪代码 |
| :rocket: (火箭) | `:rocket:` | 部署功能 |
| :white_check_mark: (白色复选框) | `:white_check_mark:` | 增加测试 |
| :memo: (备忘录)
:book: (书) | `:memo:`
`:book:` | 撰写文档 |
| :hammer: (锤子) | `:hammer:` | 重大重构 |
| :art: (调色板) | `:art:` | 改进代码结构/代码格式 |
| :fire: (火焰) | `:fire:` | 移除代码或文件 |
| :pencil2: (铅笔) | `:pencil2:` | 修复 typo |
| :construction: (施工) | `:construction:` | 工作进行中 |
| :wastebasket: (垃圾桶) | `:wastebasket:` | 废弃或删除 |
| :wheelchair: (轮椅) | `:wheelchair:` | 可访问性 |
| :construction_worker: (工人) | `:construction_worker:` | 添加 CI 构建系统 |
| :green_heart: (绿心) | `:green_heart:` | 修复 CI 构建问题 |
| :lock: (锁) | `:lock:` | 修复安全问题 |
| :whale: (鲸鱼) | `:whale:` | Docker 相关工作 |
| :apple: (苹果) | `:apple:` | 修复 macOS 下的问题 |
| :penguin: (企鹅) | `:penguin:` | 修复 Linux 下的问题 |
| :checkered_flag: (旗帜) | `:checkered_flag:` | 修复 Windows 下的问题 |
| :twisted_rightwards_arrows: (交叉箭头) | `:twisted_rightwards_arrows:` | 分支合并 |