Skip to content

Commit e6ccadc

Browse files
committed
📝 docs(readme): update supported AI providers and configuration details
- add DeepSeek to supported AI providers list - fix formatting and spacing in configuration tables - update Chinese documentation to match English version - correct prompt file reference in Chinese README - standardize configuration parameter descriptions across languages
1 parent 6a12ccb commit e6ccadc

2 files changed

Lines changed: 20 additions & 16 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<h1>AI Commit</h1>
88

9-
Use Azure/OpenAI API to review Git changes, generate conventional commit messages that meet the conventions, simplify the commit process, and keep the commit conventions consistent.
9+
Use OpenAI / Azure OpenAI / DeepSeek / Gemini API to review Git changes, generate conventional commit messages that meet the conventions, simplify the commit process, and keep the commit conventions consistent.
1010

1111
**English** · [简体中文](./README.zh_CN.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]
1212

@@ -27,7 +27,7 @@ Use Azure/OpenAI API to review Git changes, generate conventional commit message
2727

2828
## ✨ Features
2929

30-
- 🤯 Support generating commit messages based on git diffs using ChatGPT / Azure API and Gemini API.
30+
- 🤯 Support generating commit messages based on git diffs using ChatGPT / Azure API / DeepSeek / Gemini API.
3131
- 🗺️ Support multi-language commit messages.
3232
- 😜 Support adding Gitmoji.
3333
- 🛠️ Support custom system prompt.
@@ -68,10 +68,10 @@ In the VSCode settings, locate the "ai-commit" configuration options and configu
6868
| AZURE_API_VERSION | string | None | No | AZURE_API_VERSION |
6969
| OPENAI_TEMPERATURE | number | 0.7 | No | Controls randomness in the output. Range: 0-2. Lower values: more focused, Higher values: more creative |
7070
| GEMINI_API_KEY | string | None | Yes | Required when `AI Provider` is set to `Gemini`. [Gemini API key](https://makersuite.google.com/app/apikey) |
71-
| GEMINI_MODEL | string | gemini-2.0-flash-001 | Yes | Gemini MODEL. Currently, model selection is limited to configuration. |
71+
| GEMINI_MODEL | string | gemini-2.0-flash-001 | Yes | Gemini MODEL. Currently, model selection is limited to configuration. |
7272
| GEMINI_TEMPERATURE | number | 0.7 | No | Controls randomness in the output. Range: 0-2 for Gemini. Lower values: more focused, Higher values: more creative |
7373
| AI_COMMIT_LANGUAGE | string | en | Yes | Supports 19 languages |
74-
| SYSTEM_PROMPT | string | None | No | Custom system prompt |
74+
| SYSTEM_PROMPT | string | None | No | Custom system prompt |
7575

7676
## ⌨️ Local Development
7777

README.zh_CN.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<h1>AI Commit</h1>
88

9-
使用 Azure/OpenAI API 审查 Git 暂存区修改,生成符合 Conventional Commit 规范的提交消息,简化提交流程,保持提交规范一致。
9+
使用 OpenAI / Azure OpenAI / DeepSeek / Gemini API 审查 Git 暂存区修改,生成符合 Conventional Commit 规范的提交消息,简化提交流程,保持提交规范一致。
1010

1111
[English](./README.md) · **简体中文** · [报告问题][github-issues-link] · [请求功能][github-issues-link]
1212

@@ -27,7 +27,7 @@
2727

2828
## ✨ 特性
2929

30-
- 🤯 支持使用 ChatGPT / Azure API 根据 git diffs 自动生成提交信息
30+
- 🤯 支持使用 OpenAI / Azure OpenAI / DeepSeek / Gemini API 根据 git diffs 自动生成提交信息
3131
- 🗺️ 支持多语言提交信息
3232
- 😜 支持添加 Gitmoji
3333
- 🛠️ 支持自定义系统提示词
@@ -55,19 +55,23 @@
5555
5656
### ⚙️ 配置
5757

58-
> **Note** Version >= 0.0.5 不需要配置 `EMOJI_ENABLED``FULL_GITMOJI_SPEC`,默认提示词为 [prompt/without_gitmoji.md](./prompt/without_gitmoji.md),如果不需要使用 `Gitmoji`,请将 `SYSTEM_PROMPT` 设置为您的自定义提示词, 请参考 [prompt/without_gitmoji.md](./prompt/without_gitmoji.md)
58+
> **Note** Version >= 0.0.5 不需要配置 `EMOJI_ENABLED``FULL_GITMOJI_SPEC`,默认提示词为 [prompt/without_gitmoji.md](./prompt/with_gitmoji.md),如果不需要使用 `Gitmoji`,请将 `SYSTEM_PROMPT` 设置为您的自定义提示词, 请参考 [prompt/without_gitmoji.md](./prompt/without_gitmoji.md)
5959
6060
`VSCode` 设置中,找到 "ai-commit" 配置项,并根据需要进行配置
6161

62-
| 配置 | 类型 | 默认 | 必要 | 备注 |
63-
| :----------------- | :----: | :----: | :--: | :------------------------------------------------------------------------------------: |
64-
| OPENAI_API_KEY | string | None || [OpenAI 令牌](https://platform.openai.com/account/api-keys) |
65-
| OPENAI_BASE_URL | string | None || 如果是 Azure,使用:https://{resource}.openai.azure.com/openai/deployments/{model} |
66-
| OPENAI_MODEL | string | gpt-4o || OpenAI MODEL, 你可以通过运行 `Show Available OpenAI Models` 命令从列表中选择一个模型。 |
67-
| AZURE_API_VERSION | string | None || AZURE_API_VERSION |
68-
| AI_COMMIT_LANGUAGE | string | en || 支持 19 种语言 |
69-
| SYSTEM_PROMPT | string | None || 自定义系统提示词 |
70-
| OPENAI_TEMPERATURE | number | 0.7 || 控制输出的随机性。范围:0-2。较低的值:更加集中,较高的值:更有创造性 |
62+
| 配置 | 类型 | 默认 | 必要 | 备注 |
63+
| :----------------- | :----: | :------------------: | :--: | :---------------------------------------------------------------------------------------------: |
64+
| AI_PROVIDER | string | openai | Yes | Select AI Provider: `openai` or `gemini`. |
65+
| OPENAI_API_KEY | string | None || [OpenAI 令牌](https://platform.openai.com/account/api-keys) |
66+
| OPENAI_BASE_URL | string | None || 如果是 Azure,使用:https://{resource}.openai.azure.com/openai/deployments/{model} |
67+
| OPENAI_MODEL | string | gpt-4o || OpenAI MODEL, 你可以通过运行 `Show Available OpenAI Models` 命令从列表中选择一个模型。 |
68+
| AZURE_API_VERSION | string | None || AZURE_API_VERSION |
69+
| OPENAI_TEMPERATURE | number | 0.7 || 控制输出的随机性。范围:0-2。较低的值:更加集中,较高的值:更有创造性 |
70+
| GEMINI_API_KEY | string | None | Yes |`AI Provider`设置为`Gemini`时需要。[Gemini API key](https://makersuite.google.com/app/apikey) |
71+
| GEMINI_MODEL | string | gemini-2.0-flash-001 | Yes | 模型选择仅限于配 Gemini 模型。置。 |
72+
| GEMINI_TEMPERATURE | number | 0.7 | No | `Gemini` 控制输出的随机性。范围:0-2。较低的值:更加集中,较高的值:更有创造 |
73+
| AI_COMMIT_LANGUAGE | string | en || 支持 19 种语言 |
74+
| SYSTEM_PROMPT | string | None || 自定义系统提示词 |
7175

7276
## ⌨️ 本地开发
7377

0 commit comments

Comments
 (0)