mirror of
https://gitee.com/ShopeX/ECShopX
synced 2026-08-07 12:35:46 +08:00
删除文件 docs/docs/zdnf5m.md
This commit is contained in:
@@ -1,66 +0,0 @@
|
||||
---
|
||||
url: zdnf5m
|
||||
---
|
||||
|
||||
# git提交规范
|
||||
|
||||
<a name="aa02f9d1"></a>
|
||||
# 
|
||||
<a name="ANNNC"></a>
|
||||
# 1. Git commit规范
|
||||
<a name="4df7b988"></a>
|
||||
## 1.1. 格式
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
```
|
||||
示例:
|
||||
```
|
||||
fix(ngRepeat): fix trackBy function being invoked with incorrect scope
|
||||
```
|
||||
<a name="12-type"></a>
|
||||
## 1.2. type
|
||||
主要的提交类型如下:
|
||||
|
||||
| Type | 说明 | 备注 |
|
||||
| --- | --- | --- |
|
||||
| `feat` | 提交新功能 | 常用 |
|
||||
| `fix` | 修复bug | 常用 |
|
||||
| `docs` | 修改文档 | |
|
||||
| `style` | 修改格式,例如格式化代码,空格,拼写错误等 | |
|
||||
| `refactor` | 重构代码,没有添加新功能也没有修复bug | |
|
||||
| `test` | 添加或修改测试用例 | |
|
||||
| `perf` | 代码性能调优 | |
|
||||
| `chore` | 修改构建工具、构建流程、更新依赖库、文档生成逻辑 | 例如vendor包 |
|
||||
|
||||
<a name="13-scope"></a>
|
||||
## 1.3. scope
|
||||
表示此次commit涉及的文件范围,可以使用`*`来表示涉及多个范围。
|
||||
<a name="14-subject"></a>
|
||||
## 1.4. subject
|
||||
描述此次commit涉及的修改内容。
|
||||
|
||||
- 使用祈使句(动词开头)、动宾短语。
|
||||
- 第一个字母不要大写。
|
||||
- 不要以`.`句号结尾。
|
||||
<a name="3190f7e5"></a>
|
||||
# 2. Git commit工具
|
||||
安装`commitizen`和`cz-conventional-changelog`。
|
||||
```
|
||||
npm install -g commitizen cz-conventional-changelog
|
||||
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
|
||||
```
|
||||
使用cz-cli
|
||||
```
|
||||
$ git cz
|
||||
cz-cli@4.0.3, cz-conventional-changelog@3.0.1
|
||||
? Select the type of change that you're committing: (Use arrow keys)
|
||||
❯ feat: A new feature
|
||||
fix: A bug fix
|
||||
docs: Documentation only changes
|
||||
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
|
||||
refactor: A code change that neither fixes a bug nor adds a feature
|
||||
perf: A code change that improves performance
|
||||
test: Adding missing tests or correcting existing tests
|
||||
(Move up and down to reveal more choices)
|
||||
```
|
||||
[<br />](https://www.huweihuang.com/linux-notes/git/git-alias-zsh.html)
|
||||
Reference in New Issue
Block a user