Skip to content

Commit 86a4b31

Browse files
committed
📝 docs(README): 更新安装和配置文档
- 添加对自定义系统提示词的支持说明 - 简化配置项说明,移除不必要的配置项 📝 docs(README.zh_CN): 更新安装和配置文档 - 添加对自定义系统提示词的支持说明 - 简化配置项说明,移除不必要的配置项
1 parent ff606f3 commit 86a4b31

2 files changed

Lines changed: 22 additions & 18 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Use Azure/OpenAI API to review Git changes, generate conventional commit message
3030
- 🤯 Support generating commit messages based on git diffs using ChatGPT / Azure API.
3131
- 🗺️ Support multi-language commit messages.
3232
- 😜 Support adding Gitmoji.
33+
- 🛠️ Support custom system prompt.
3334
- 📝 Support Conventional Commits specification.
3435

3536
## 📦 Installation
@@ -53,17 +54,18 @@ Use Azure/OpenAI API to review Git changes, generate conventional commit message
5354
5455
### ⚙️ Configuration
5556

57+
> **Note** Version >= 0.0.5 Don't need to configure `EMOJI_ENABLED` and `FULL_GITMOJI_SPEC`,If don't need to use `Gitmoji`. Please set `SYSTEM_PROMPT` to empty.
58+
5659
In the VSCode settings, locate the "ai-commit" configuration options and configure them as needed:
5760

58-
| Configuration | Type | Default | Required | Notes |
59-
| :----------------- | :-----: | :-----------: | :------: | :------------------------------------------------------------------------------------------: |
60-
| OPENAI_API_KEY | string | None | Yes | [OpenAI token](https://platform.openai.com/account/api-keys) |
61-
| OPENAI_BASE_URL | string | None | No | If using Azure, use: https://{resource}.openai.azure.com/openai/deployments/{model} |
62-
| OPENAI_MODEL | string | gpt-3.5-turbo | Yes | OpenAI MODEL |
63-
| AZURE_API_VERSION | string | None | No | AZURE_API_VERSION |
64-
| AI_COMMIT_LANGUAGE | string | en | Yes | Supports 19 languages |
65-
| EMOJI_ENABLED | boolean | true | Yes | Enable or disable Emoji |
66-
| FULL_GITMOJI_SPEC | boolean | false | No | Enable the complete GitEmoji specification, see [https://gitmoji.dev/](https://gitmoji.dev/) |
61+
| Configuration | Type | Default | Required | Notes |
62+
| :----------------- | :----: | :-----: | :------: | :---------------------------------------------------------------------------------: |
63+
| OPENAI_API_KEY | string | None | Yes | [OpenAI token](https://platform.openai.com/account/api-keys) |
64+
| OPENAI_BASE_URL | string | None | No | If using Azure, use: https://{resource}.openai.azure.com/openai/deployments/{model} |
65+
| OPENAI_MODEL | string | gpt-4o | Yes | OpenAI MODEL |
66+
| AZURE_API_VERSION | string | None | No | AZURE_API_VERSION |
67+
| AI_COMMIT_LANGUAGE | string | en | Yes | Supports 19 languages |
68+
| SYSTEM_PROMPT | string | None | No | Custom system prompt |
6769

6870
## ⌨️ Local Development
6971

README.zh_CN.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
- 🤯 支持使用 ChatGPT / Azure API 根据 git diffs 自动生成提交信息
3131
- 🗺️ 支持多语言提交信息
3232
- 😜 支持添加 Gitmoji
33+
- 🛠️ 支持自定义系统提示词
3334
- 📝 支持 Conventional Commits 规范
3435

3536
## 📦 安装
@@ -53,17 +54,18 @@
5354
5455
### ⚙️ 配置
5556

57+
> **Note** Version >= 0.0.5 不需要配置 `EMOJI_ENABLED``FULL_GITMOJI_SPEC`,如果不需要使用 `Gitmoji`,请将 `SYSTEM_PROMPT` 设置为空。
58+
5659
`VSCode` 设置中,找到 "ai-commit" 配置项,并根据需要进行配置
5760

58-
| 配置 | 类型 | 默认 | 必要 | 备注 |
59-
| :----------------- | :-----: | :-----------: | :--: | :--------------------------------------------------------------------------------: |
60-
| OPENAI_API_KEY | string | None || [OpenAI 令牌](https://platform.openai.com/account/api-keys) |
61-
| OPENAI_BASE_URL | string | None || 如果是 Azure,使用:https://{resource}.openai.azure.com/openai/deployments/{model} |
62-
| OPENAI_MODEL | string | gpt-3.5-turbo || OpenAI MODEL |
63-
| AZURE_API_VERSION | string | None || AZURE_API_VERSION |
64-
| AI_COMMIT_LANGUAGE | string | en || 支持 19 种语言 |
65-
| EMOJI_ENABLED | boolean | true || 是否开启 Emoji |
66-
| FULL_GITMOJI_SPEC | boolean | false || 是否开启完整的 GitEmoji 规范,参考 [https://gitmoji.dev/](https://gitmoji.dev/) |
61+
| 配置 | 类型 | 默认 | 必要 | 备注 |
62+
| :----------------- | :----: | :----: | :--: | :--------------------------------------------------------------------------------: |
63+
| OPENAI_API_KEY | string | None || [OpenAI 令牌](https://platform.openai.com/account/api-keys) |
64+
| OPENAI_BASE_URL | string | None || 如果是 Azure,使用:https://{resource}.openai.azure.com/openai/deployments/{model} |
65+
| OPENAI_MODEL | string | gpt-4o || OpenAI MODEL |
66+
| AZURE_API_VERSION | string | None || AZURE_API_VERSION |
67+
| AI_COMMIT_LANGUAGE | string | en || 支持 19 种语言 |
68+
| SYSTEM_PROMPT | string | None || 自定义系统提示词 |
6769

6870
## ⌨️ 本地开发
6971

0 commit comments

Comments
 (0)