|
1 | 1 | # GitFlow ToolKit
|
2 | 2 |
|
3 |
| -> 这是一个使用 go 编写的简单的 GitFlow 提交工具,用于规范 git commit 提交格式,目前仅支持 [Angular 社区规范](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0);同时该工具集成了一些扩展动作,比如快速创建指定名称前缀分支等 |
| 3 | +> GitFlow Toolkit is a gitflow commit tool written by go, used to standardize the format of git commit message and quickly create gitflow branches, |
| 4 | +> It should be noted that GitFlow Toolkit currently only supports the generation of the commit message style of the [Angular community specification](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0). |
4 | 5 |
|
5 | 6 | <p align="center">
|
6 | 7 | <img src="https://raw.githubusercontent.com/mritd/gitflow-toolkit/master/gitflow-toolkit.svg?sanitize=true" width="1200" alt="gitflow-toolkit demo">
|
7 | 8 | </p>
|
8 | 9 |
|
9 |
| -## 支持命令 |
| 10 | +## Installation |
10 | 11 |
|
11 |
| -| 命令 | 描述 | |
| 12 | +Just download the latest version from the Release page and execute the install command: |
| 13 | + |
| 14 | +```sh |
| 15 | +export VERSION='v2.0.0' |
| 16 | + |
| 17 | +# download bin file |
| 18 | +wget https://github.com/mritd/gitflow-toolkit/releases/download/${VERSION}/gitflow-toolkit_darwin_amd64 |
| 19 | + |
| 20 | +# add permissions |
| 21 | +chmod +x gitflow-toolkit_darwin_amd64 |
| 22 | + |
| 23 | +# install |
| 24 | +sudo ./gitflow-toolkit_darwin_amd64 install |
| 25 | +``` |
| 26 | + |
| 27 | +After the installation is complete, you can delete the bin file. |
| 28 | + |
| 29 | +If the go language development environment is installed locally, you can install it through the `go get` command: |
| 30 | + |
| 31 | +```sh |
| 32 | +go get -u github.com/mritd/gitflow-toolkit/v2 |
| 33 | +``` |
| 34 | + |
| 35 | +## Comands |
| 36 | + |
| 37 | +| cmd | desc | |
12 | 38 | | --- | --- |
|
13 |
| -| ci | 交互式输入 `commit message` | |
14 |
| -| cm | 接受一个 `commit message` 字符串,并校验其格式(用作 commit hook) | |
15 |
| -| feat | 接受一个字符串,并创建一个 feat 分支,分支名称格式为 `feat/xxx` | |
16 |
| -| fix | 创建 fix 分支 | |
17 |
| -| hotfix | 创建 hotfix 分支(通常用于对 master 紧急修复) | |
18 |
| -| docs | 创建 docs 分支 | |
19 |
| -| style | 创建 style 分支 | |
20 |
| -| refactor | 创建 refactor 分支 | |
21 |
| -| chore | 创建 chore 分支 | |
22 |
| -| perf | 创建 perf 分支 | |
23 |
| -| style | 创建 style 分支 | |
24 |
| -| ps | 推送当前分支到远程(git push origin xxxx) | |
25 |
| - |
26 |
| -## 安装与卸载 |
27 |
| - |
28 |
| -下载对应二进制文件,执行 `sudo gitflow-toolkit install/uninstall` 即可 |
| 39 | +| `git ci` | Enter commit message interactively | |
| 40 | +| `git ps` | Push the current branch to the remote | |
| 41 | +| `git feat NAME` | Checkout a new branch from the current branch (`feat/NAME`) | |
| 42 | +| `git fix NAME` | `git checkout -b fix/NAME` | |
| 43 | +| `git hotfix NAME` | `git checkout -b hotfix/NAME` | |
| 44 | +| `git docs NAME` | `git checkout -b docs/NAME` | |
| 45 | +| `git style NAME` | `git checkout -b style/NAME` | |
| 46 | +| `git refactor NAME` | `git checkout -b refactor/NAME` | |
| 47 | +| `git chore NAME` | `git checkout -b chore/NAME` | |
| 48 | +| `git perf NAME` | `git checkout -b perf/NAME` | |
| 49 | +| `git style NAME` | `git checkout -b style/NAME` | |
| 50 | + |
0 commit comments