Skip to content

Commit a469c2c

Browse files
committed
✨ feat(docs): add model selection info
- Add information on how to select an OpenAI model【docs(README.md)】 - Update the Chinese version of README to match【docs(README.zh_CN.md)】 📦 build(version): update version - Increment version from 0.0.7 to 0.0.8【package.json】
1 parent 0071958 commit a469c2c

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,14 @@ Use Azure/OpenAI API to review Git changes, generate conventional commit message
5858
5959
In the VSCode settings, locate the "ai-commit" configuration options and configure them as needed:
6060

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 |
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,you can select a model from the list by running the `Show Available OpenAI Models` command |
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 |
6969

7070
## ⌨️ Local Development
7171

README.zh_CN.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,14 @@
5858
5959
`VSCode` 设置中,找到 "ai-commit" 配置项,并根据需要进行配置
6060

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 || 自定义系统提示词 |
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, 你可以通过运行 `Show Available OpenAI Models` 命令从列表中选择一个模型。 |
66+
| AZURE_API_VERSION | string | None || AZURE_API_VERSION |
67+
| AI_COMMIT_LANGUAGE | string | en || 支持 19 种语言 |
68+
| SYSTEM_PROMPT | string | None || 自定义系统提示词 |
6969

7070
## ⌨️ 本地开发
7171

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "ai-commit",
33
"displayName": "AI Commit",
44
"description": "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.",
5-
"version": "0.0.7",
5+
"version": "0.0.8",
66
"engines": {
77
"node": ">=16",
88
"vscode": "^1.77.0"

0 commit comments

Comments
 (0)