vscode-commitizen 技术文档

vscode-commitizen 技术文档

vscode-commitizen Visual Studio Code Commitizen Support 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-commitizen

安装指南

1. 安装 Visual Studio Code

首先，确保你已经安装了 Visual Studio Code。如果尚未安装，请前往官方网站下载并安装。

2. 安装 vscode-commitizen 扩展

1. 打开 Visual Studio Code。
2. 点击左侧活动栏中的扩展图标（或按 Ctrl+Shift+X）。
3. 在搜索框中输入 vscode-commitizen。
4. 找到 vscode-commitizen 扩展，点击“安装”按钮。

项目的使用说明

1. 打开命令面板

在 Visual Studio Code 中，按 Ctrl+Shift+P（Windows/Linux）或 Command+Shift+P（Mac）打开命令面板。

2. 执行常规提交

1. 在命令面板中输入 conventional commit。
2. 选择该命令后，系统会提示你回答一系列问题，包括类型、范围、主题、正文、重大变更和关闭的问题。
3. 回答完所有问题后，提交将自动完成。

3. 取消提交

在回答问题的过程中，如果需要取消提交，只需按 ESC 键即可。

项目API使用文档

配置文件

vscode-commitizen 扩展支持自定义配置文件，你可以通过以下方式配置：

1. 在项目根目录下创建一个 .cz-config.js 文件。
2. 在 package.json 中指定配置文件路径：

   "config": {
     "cz-customizable": {
       "config": "test.js"
     }
   }
   

3. 如果未找到上述配置文件，扩展将使用默认配置。

项目安装方式

通过 Visual Studio Code 市场安装

1. 打开 Visual Studio Code。
2. 点击左侧活动栏中的扩展图标（或按 Ctrl+Shift+X）。
3. 在搜索框中输入 vscode-commitizen。
4. 找到 vscode-commitizen 扩展，点击“安装”按钮。

通过命令行安装

1. 打开终端。
2. 运行以下命令：

   code --install-extension knisterpeter.vscode-commitizen
   

通过以上步骤，你可以成功安装并使用 vscode-commitizen 扩展，实现常规提交的自动化。

vscode-commitizen Visual Studio Code Commitizen Support 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-commitizen