icommit v0.0.20

icommit

介绍

icommit 是一个撰写合格 Commit message 的工具，遵循 angular commit 规范。

以后，凡是用到 git commit 命令，一律改为使用 git ct。这时，就会出现选项，用来生成符合格式的 Commit message。

0. git ct

0.1 选择 Commit 类型

0.2 输入 Commit 主题

尽量简洁明了，不用写的过于细节。

建议不超过 50 个字符

0.3 输入影响范围(scope)

用于说明 Commit 影响的范围

如果不止一个 scope，则直接按 Enter

0.4 输入关联的 Issue 编号

可以是 github/gitlab 等的 Issue 编号；也支持 teambition 的 taskId

会在当次 Commit 中添加 Closes #编号 的 Footer；生成 CHANGELOG 时，会创建一个超链

多个编号用 , 分隔；同一次提交，编号应该为同一类型

如果没有，则按 Enter 跳过

0.5 选择 Issue 编号的类型

关联上一步，选择 Issue 编号的类型

0.6 输入 Commit 详细说明

是对当次 Commit 的详细描述

如果没有，则按 Enter 跳过

0.7 是否存在不兼容变动

如果当次 Commit 会导致某些代码存在不兼容的修改，则输入 Y；否则直接按 Enter

输入 Y，则进入 0.9

输入 N，或直接按 Enter ，则进入 0.8

0.8 提交成功

0.9 输入不兼容的变动

内容模板

保存

0.10 提交成功

提交的 Commit 具体内容

1. git cl

生成 CHANGELGO

生成的 CHANGELOG 示例

选项

使用 -l 或 --lite，生成精简的 Commit message

git ct -l

// 或

git ct --lite

[旗子] Angular Commit 规范
[旗子] 可自动生成 CHANGELOG
[旗子] 使用 git ct 代替 git commit

1. 安装

npm i icommit -g

2. 使用

2.1 git ct

之前使用 git commit 的地方，直接用 git ct 代替，ct 为 commit 缩写

git ct 命令只会生成并提交 Commit，不会执行 git push，需要手动执行 git push，或执行 git cl

2.1.1 支持 -l 或--lite

生成最小单元的 Commit Message

2.2 git cl

cl 为 changelog 缩写，用于生成 CHANGELOG

git cl 包含多个命令

• 生成 CHANGELOG
• git add package.json && git add CHANGELOG.md
• git tag X.X.X（tag 为 package.json 中的 version 字段）
• git push

3. 工作流

3.1. 修改代码
3.2. git add .
3.3. git ct 生成语义化的 Commit Message
3.4. 可选的:git cl 生成 CHANGELOG，执行此步时，不需要再执行第 5 步
3.5. 未执行第 4 步时，执行此步。git push

4. Commit 建议

• 少修改，多提交。尽可能每改一个要点就提交一次
• 不要每提交一次就推送一次，多积攒几个提交后一次性推送

5. Commit Type

• feat: 新增 feature
• fix: 修复 bug
• docs: 仅仅修改了文档，如 readme.md
• style: 仅仅是对格式进行修改，如逗号、缩进、空格等。不改变代码逻辑。
• refactor: 代码重构，没有新增功能或修复 bug
• perf: 优化相关，如提升性能、用户体验等。
• test: 测试用例，包括单元测试、集成测试。
• chore: 改变构建流程、或者增加依赖库、工具等。
• build: 影响项目构建或依赖项修改
• ci: 持续集成相关文件修改