From a469c2caf13f59d19e04e03f508de47662052b8b Mon Sep 17 00:00:00 2001 From: shitao <133397418@qq.com> Date: Tue, 12 Nov 2024 09:39:26 +0800 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20feat(docs):=20add=20model=20selecti?= =?UTF-8?q?on=20info?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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】 --- README.md | 16 ++++++++-------- README.zh_CN.md | 16 ++++++++-------- package.json | 2 +- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 790d9cd..a675c4b 100644 --- a/README.md +++ b/README.md @@ -58,14 +58,14 @@ Use Azure/OpenAI API to review Git changes, generate conventional commit message In the VSCode settings, locate the "ai-commit" configuration options and configure them as needed: -| Configuration | Type | Default | Required | Notes | -| :----------------- | :----: | :-----: | :------: | :---------------------------------------------------------------------------------: | -| OPENAI_API_KEY | string | None | Yes | [OpenAI token](https://platform.openai.com/account/api-keys) | -| OPENAI_BASE_URL | string | None | No | If using Azure, use: https://{resource}.openai.azure.com/openai/deployments/{model} | -| OPENAI_MODEL | string | gpt-4o | Yes | OpenAI MODEL | -| AZURE_API_VERSION | string | None | No | AZURE_API_VERSION | -| AI_COMMIT_LANGUAGE | string | en | Yes | Supports 19 languages | -| SYSTEM_PROMPT | string | None | No | Custom system prompt | +| Configuration | Type | Default | Required | Notes | +| :----------------- | :----: | :-----: | :------: | :-----------------------------------------------------------------------------------------------------: | +| OPENAI_API_KEY | string | None | Yes | [OpenAI token](https://platform.openai.com/account/api-keys) | +| OPENAI_BASE_URL | string | None | No | If using Azure, use: https://{resource}.openai.azure.com/openai/deployments/{model} | +| OPENAI_MODEL | string | gpt-4o | Yes | OpenAI MODEL,you can select a model from the list by running the `Show Available OpenAI Models` command | +| AZURE_API_VERSION | string | None | No | AZURE_API_VERSION | +| AI_COMMIT_LANGUAGE | string | en | Yes | Supports 19 languages | +| SYSTEM_PROMPT | string | None | No | Custom system prompt | ## ⌨️ Local Development diff --git a/README.zh_CN.md b/README.zh_CN.md index a1b12fa..2db64f4 100644 --- a/README.zh_CN.md +++ b/README.zh_CN.md @@ -58,14 +58,14 @@ 在 `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 | -| AZURE_API_VERSION | string | None | 否 | AZURE_API_VERSION | -| AI_COMMIT_LANGUAGE | string | en | 是 | 支持 19 种语言 | -| SYSTEM_PROMPT | string | None | 否 | 自定义系统提示词 | +| 配置 | 类型 | 默认 | 必要 | 备注 | +| :----------------- | :----: | :----: | :--: | :------------------------------------------------------------------------------------: | +| 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 | 否 | 自定义系统提示词 | ## ⌨️ 本地开发 diff --git a/package.json b/package.json index 964491f..8cff96c 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "ai-commit", "displayName": "AI Commit", "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.", - "version": "0.0.7", + "version": "0.0.8", "engines": { "node": ">=16", "vscode": "^1.77.0"