Skip to content

Commit 79eda9d

Browse files
littleCarelesslittleCareless
committed
📝 docs(readme): 更新 README 文件以包含更多 AI 服务支持
- 添加对智谱 AI、DashScope 和 豆包 AI 的支持说明 - 更新配置指南和依赖要求 - 增加常见问题和开发指南部分
1 parent 9a39771 commit 79eda9d

File tree

2 files changed

+145
-30
lines changed

2 files changed

+145
-30
lines changed

‎README.md

+102-6
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A VSCode extension for generating standardized Git/SVN commit messages using AI
2323

2424
[English](README.md) | [简体中文](README.zh-CN.md)
2525

26-
A VSCode extension for generating standardized Git/SVN commit messages using AI. Supports OpenAI, Ollama, and VSCode built-in AI services.
26+
A VSCode extension for generating standardized Git/SVN commit messages using AI. Supports OpenAI, Ollama, VSCode built-in AI services, Zhipu AI, DashScope, and Doubao AI.
2727

2828
## Features
2929

@@ -32,6 +32,9 @@ A VSCode extension for generating standardized Git/SVN commit messages using AI.
3232
- OpenAI API support (GPT-3.5/GPT-4/Other)
3333
- Ollama local model support
3434
- VSCode built-in AI support
35+
- Zhipu AI support
36+
- DashScope support
37+
- Doubao AI support
3538

3639
### 📝 Version Control System Support
3740

@@ -42,9 +45,9 @@ A VSCode extension for generating standardized Git/SVN commit messages using AI.
4245

4346
Supports 19 languages including:
4447

45-
- English
4648
- Simplified Chinese
4749
- Traditional Chinese
50+
- English
4851
- Japanese
4952
- Korean
5053

@@ -69,6 +72,9 @@ Supports 19 languages including:
6972
| dish-ai-commit.model | string | gpt-3.5-turbo | AI model selection |
7073
| dish-ai-commit.openai.apiKey | string | - | OpenAI API key |
7174
| dish-ai-commit.openai.baseUrl | string | https://api.openai.com/v1 | OpenAI API base URL |
75+
| dish-ai-commit.zhipuai.apiKey | string | - | Zhipu AI API key |
76+
| dish-ai-commit.dashscope.apiKey | string | - | DashScope API key |
77+
| dish-ai-commit.doubao.apiKey | string | - | Doubao API key |
7278
| dish-ai-commit.ollama.baseUrl | string | http://localhost:11434 | Ollama API base URL |
7379
| dish-ai-commit.enableDiffSimplification | boolean | false | Enable diff content simplification |
7480
| dish-ai-commit.diffSimplification.maxLineLength | number | 120 | Maximum line length after simplification |
@@ -80,15 +86,105 @@ Supports 19 languages including:
8086
- `Generate Commit Message`: Generate commit message based on current changes
8187
- `Select AI Model`: Choose the AI model to use
8288

83-
## Configuration Guide
89+
## Configuration Instructions
8490

8591
1. OpenAI Configuration
8692

87-
## 🛠️ Local Development
93+
```json
94+
{
95+
"dish-ai-commit.PROVIDER": "openai",
96+
"dish-ai-commit.OPENAI_API_KEY": "your-api-key",
97+
"dish-ai-commit.OPENAI_BASE_URL": "https://api.openai.com/v1"
98+
}
99+
```
100+
101+
2. Ollama onfiguration
102+
103+
```json
104+
{
105+
"dish-ai-commit.PROVIDER": "ollama",
106+
"dish-ai-commit.OLLAMA_BASE_URL": "http://localhost:11434"
107+
}
108+
```
109+
110+
3. VSCode onfiguration
111+
112+
```json
113+
{
114+
"dish-ai-commit.PROVIDER": "vscode"
115+
}
116+
```
117+
118+
## 📋 How to use
119+
120+
- Select the file to be submitted from the source code manager
121+
- Click the "Dish AI Commit" icon in the source code manager title bar
122+
- Or execute the "Dish AI Commit" command in the command panel
123+
- AI will automatically generate a submission message that meets the specifications
124+
125+
## 📥 Install
126+
127+
1. Search "Dish AI Commit" from the VS Code extension market
128+
2. Click to install
129+
3. Restart VS Code
130+
4. Configure AI service parameters according to actual needs
131+
132+
## 📝 Changelog
133+
134+
See [CHANGELOG.md](CHANGELOG.md) for a detailed version history.
135+
136+
## 📋 Dependency Requirements
137+
138+
- VS Code 1.80.0+
139+
- [SVN command line tool](http://subversion.apache.org/packages.html)
140+
- SVN SCM (optional) - To enter commit information in the SCM input box of VSCode, please install [SVN SCM v2.18.1+](https://github.com/littleCareless/svn-scm/releases/tag/v2.18.1)
141+
- Valid AI service configuration (OpenAI API Key or Ollama service)
142+
143+
## 💡 Frequently asked questions
144+
145+
- Ensure that the SVN command line tool is correctly installed and accessible
146+
- Ensure that the SVN SCM extension is correctly installed and enabled
147+
- Configure the correct AI service parameters
148+
- Ensure that the network can access the selected AI service
149+
150+
## 🛠️ Development Guide
151+
152+
You can use Github Codespaces for online development:
153+
154+
[![github-codespace][github-codespace-shield]][github-codespace-link]
155+
156+
Alternatively, you can clone the repository and run the following command for local development:
157+
158+
```bash
159+
$ git clone https://github.com/littleCareless/dish-ai-commit
160+
$ cd ai-commit
161+
$ npm install
162+
```
163+
164+
Open the project folder in VSCode. Press F5 to run the project. A new Extension Development Host window will pop up and start the extension.
165+
166+
## 🤝 Contribution Guidelines
167+
168+
We welcome all forms of contributions, including but not limited to:
169+
170+
- Submit [Issues][github-issues-link] to report bugs
171+
- Propose new features
172+
- Submit Pull Request to improve the code
173+
- Improve the documentation
174+
175+
Please make sure before submitting a PR:
176+
177+
1. The code has been tested
178+
179+
2. Update the relevant documents
180+
181+
3. Follow the project code specifications
182+
183+
[![][pr-welcome-shield]][pr-welcome-link]
88184

89-
You can follow these steps for local development:
185+
### 💗 Thanks to our contributors
90186

91-
1. Clone the repository
187+
[![][github-contrib-shield]][github-contrib-link]
92188

93189
## 🙏 Acknowledgments
94190

‎README.zh-CN.md

+43-24
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
[English](README.md) | [简体中文](README.zh-CN.md)
2525

26-
用 AI 辅助生成规范的 Git/SVN 提交信息的 VSCode 扩展。支持 OpenAI、Ollama 和 VSCode 内置 AI 服务。
26+
用 AI 辅助生成规范的 Git/SVN 提交信息的 VSCode 扩展。支持 OpenAI、Ollama、VSCode 内置 AI 服务、智谱 AI、DashScope 和 豆包 AI。
2727

2828
## 功能特性
2929

@@ -32,6 +32,9 @@
3232
- OpenAI API 支持 (GPT-3.5/GPT-4/Other)
3333
- Ollama 本地模型支持
3434
- VSCode 内置 AI 支持
35+
- 智谱 AI 支持
36+
- DashScope 支持
37+
- 豆包 AI 支持
3538

3639
### 📝 版本控制系统支持
3740

@@ -61,6 +64,9 @@
6164
| dish-ai-commit.model | string | gpt-3.5-turbo | AI 模型选择 |
6265
| dish-ai-commit.openai.apiKey | string | - | OpenAI API 密钥 |
6366
| dish-ai-commit.openai.baseUrl | string | https://api.openai.com/v1 | OpenAI API 基础 URL |
67+
| dish-ai-commit.zhipuai.apiKey | string | - | 智谱 AI API 密钥 |
68+
| dish-ai-commit.dashscope.apiKey | string | - | DashScope API 密钥 |
69+
| dish-ai-commit.doubao.apiKey | string | - | 豆包 API 密钥 |
6470
| dish-ai-commit.ollama.baseUrl | string | http://localhost:11434 | Ollama API 基础 URL |
6571
| dish-ai-commit.enableDiffSimplification | boolean | false | 启用 diff 内容简化功能 |
6672
| dish-ai-commit.diffSimplification.maxLineLength | number | 120 | 简化后每行的最大长度 |
@@ -117,13 +123,43 @@
117123

118124
## 📝 更新日志
119125

120-
查看 [CHANGELOG.md](CHANGELOG.md) 了解详细的版本更新历史。
126+
查看 [CHANGELOG.zh-CN.md](CHANGELOG.zh-CN.md) 了解详细的版本更新历史。
127+
128+
## 📋 依赖要求
129+
130+
- VS Code 1.80.0+
131+
- [SVN 命令行工具](http://subversion.apache.org/packages.html)
132+
- SVN SCM (可选) - 如需在 VSCode 的 SCM 输入框中输入提交信息，请安装 [SVN SCM v2.18.1+](https://github.com/littleCareless/svn-scm/releases/tag/v2.18.1)
133+
- 有效的 AI 服务配置(OpenAI API Key 或 Ollama 服务)
134+
135+
## 💡 常见问题
136+
137+
- 确保 SVN 命令行工具已正确安装并可访问
138+
- 确保 SVN SCM 扩展已正确安装并启用
139+
- 配置正确的 AI 服务参数
140+
- 确保网络可以访问选择的 AI 服务
141+
142+
## 🛠️ 开发指南
143+
144+
可以使用 Github Codespaces 进行在线开发：
145+
146+
[![github-codespace][github-codespace-shield]][github-codespace-link]
147+
148+
或者，可以克隆存储库并运行以下命令进行本地开发：
149+
150+
```bash
151+
$ git clone https://github.com/littleCareless/dish-ai-commit
152+
$ cd ai-commit
153+
$ npm install
154+
```
155+
156+
在 VSCode 中打开项目文件夹。按 F5 键运行项目。会弹出一个新的 Extension Development Host 窗口，并在其中启动插件。
121157

122158
## 🤝 贡献指南
123159

124160
我们欢迎所有形式的贡献，包括但不限于：
125161

126-
- 提交 Issue 报告 bug
162+
- 提交 [Issues][github-issues-link] 报告 bug
127163
- 提出新功能建议
128164
- 提交 Pull Request 改进代码
129165
- 完善文档
@@ -134,25 +170,11 @@
134170
2. 更新相关文档
135171
3. 遵循项目代码规范
136172

137-
## 📋 依赖要求
173+
[![][pr-welcome-shield]][pr-welcome-link]
138174

139-
- VS Code 1.80.0+
140-
- [SVN 命令行工具](http://subversion.apache.org/packages.html)
141-
- SVN SCM (可选) - 如需在 VSCode 的 SCM 输入框中输入提交信息，请安装 [SVN SCM v2.18.1+](https://github.com/littleCareless/svn-scm/releases/tag/v2.18.1)
142-
- 有效的 AI 服务配置(OpenAI API Key 或 Ollama 服务)
175+
### 💗 感谢我们的贡献者
143176

144-
## 💡 常见问题
145-
146-
- 确保 SVN 命令行工具已正确安装并可访问
147-
- 配置正确的 AI 服务参数
148-
- 确保网络可以访问选择的 AI 服务
149-
150-
## 🛠️ 开发指南
151-
152-
1. 克隆仓库
153-
2. 运行 `npm install` 安装依赖
154-
3. 运行 `npm run compile` 编译代码
155-
4. 按 `F5` 启动调试
177+
[![][github-contrib-shield]][github-contrib-link]
156178

157179
### 功能特性（补充）
158180

@@ -166,10 +188,7 @@
166188
允许用户自定义提交信息的模板格式（如：包括关联的 Jira 票号、功能描述等），AI 会根据模板生成符合要求的提交信息。
167189

168190
- [ ] **⚙️ 深度配置选项**
169-
提供更多的配置项，比如是否启用 AI 生成的建议，生成提交信息的详细程度，是否自动修改现有提交信息等。
170-
171-
- [ ] **🔒 安全性功能**
172-
加密存储 API 密钥，确保敏感信息不被泄露，并提供额外的身份验证机制来提高安全性。
191+
提供更多的配置项，比如是否启用 AI 生成的建议，生成提交信息的详细程度，是否自动修改现有提交信息, 是否要添加 emoji 等。
173192

174193
## 🙏 致谢
175194

0 commit comments

Comments
 (0)