Skip to content

Commit

Permalink
📝 docs(readme): update supported AI providers and configuration details
Browse files Browse the repository at this point in the history 
- 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
  • Loading branch information
@Sitoi
Sitoi committed Feb 11, 2025
1 parent 6a12ccb commit e6ccadc
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 16 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<h1>AI Commit</h1>

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.
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.

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

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

## ✨ Features

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

## ⌨️ Local Development

Expand Down
28 changes: 16 additions & 12 deletions README.zh_CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<h1>AI Commit</h1>

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

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

Expand All @@ -27,7 +27,7 @@

## ✨ 特性

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

> **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)。
> **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)。
在 `VSCode` 设置中，找到 "ai-commit" 配置项，并根据需要进行配置

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

## ⌨️ 本地开发

Expand Down

0 comments on commit e6ccadc

Please sign in to comment.