Skip to content

Commit 2e3c5b4

Browse files
littleCarelesslittleCareless
committed
✨ docs: Update README and README.zh-CN files
Project Name and Description: Updated to reflect the latest branding and scope. Links and Badges: Added relevant project links and modernized badges for better visibility. Demo Animation: Replaced with the latest project demonstration for clarity and engagement. Changes applied to both README and README.zh-CN for consistency across English and Chinese documentation.
1 parent 37c6da6 commit 2e3c5b4

File tree

2 files changed

+143
-19
lines changed

2 files changed

+143
-19
lines changed

‎README.md

+75-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
1-
# Dish AI Commit Gen
1+
<div align="center">
2+
3+
<h1>Dish AI Commit Gen</h1>
4+
5+
A VSCode extension for generating standardized Git/SVN commit messages using AI
6+
7+
[Report Bug][github-issues-link] · [Request Feature][github-issues-link]
8+
<!-- SHIELD GROUP -->
9+
10+
[![][github-contributors-shield]][github-contributors-link]
11+
[![][github-forks-shield]][github-forks-link]
12+
[![][github-stars-shield]][github-stars-link]
13+
[![][github-issues-shield]][github-issues-link]
14+
[![][vscode-marketplace-shield]][vscode-marketplace-link]
15+
[![][total-installs-shield]][total-installs-link]
16+
[![][avarage-rating-shield]][avarage-rating-link]
17+
[![][github-license-shield]][github-license-link]
18+
19+
![Demo](images/demo.gif)
20+
21+
</div>
222

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

@@ -19,12 +39,12 @@ A VSCode extension for generating standardized Git/SVN commit messages using AI.
1939

2040
### 🌍 Multi-language Commit Message Generation:
2141

42+
Supports 19 languages including:
2243
- English
2344
- Simplified Chinese
2445
- Traditional Chinese
2546
- Japanese
2647
- Korean
27-
and 19 other languages
2848

2949
### 🎨 Conventional Commits Compliant
3050

@@ -39,13 +59,15 @@ A VSCode extension for generating standardized Git/SVN commit messages using AI.
3959

4060
### Configuration
4161

42-
- `dish-ai-commit.PROVIDER`: AI provider selection (openai/ollama/vscode)
43-
- `dish-ai-commit.MODEL`: AI model to use
44-
- `dish-ai-commit.OPENAI_API_KEY`: OpenAI API key
45-
- `dish-ai-commit.OPENAI_BASE_URL`: OpenAI API base URL
46-
- `dish-ai-commit.OLLAMA_BASE_URL`: Ollama API URL
47-
- `dish-ai-commit.AI_COMMIT_LANGUAGE`: Language for generated commit messages
48-
- `dish-ai-commit.AI_COMMIT_SYSTEM_PROMPT`: Custom system prompt
62+
| Configuration | Type | Default | Required |
63+
|--------------|------|---------|-----------|
64+
| dish-ai-commit.AI_COMMIT_LANGUAGE | string | Simplified Chinese | Yes |
65+
| dish-ai-commit.AI_COMMIT_SYSTEM_PROMPT | string | "" | No |
66+
| dish-ai-commit.provider | string | OpenAI | Yes |
67+
| dish-ai-commit.model | string | gpt-3.5-turbo | Yes |
68+
| dish-ai-commit.openai.apiKey | string | - | Yes |
69+
| dish-ai-commit.openai.baseUrl | string | https://api.openai.com/v1 | No |
70+
| dish-ai-commit.ollama.baseUrl | string | http://localhost:11434 | No |
4971

5072
### Commands
5173

@@ -55,3 +77,47 @@ A VSCode extension for generating standardized Git/SVN commit messages using AI.
5577
## Configuration Guide
5678

5779
1. OpenAI Configuration
80+
81+
## 🛠️ Local Development
82+
83+
You can follow these steps for local development:
84+
85+
1. Clone the repository
86+
87+
## 🙏 Acknowledgments
88+
89+
This project is inspired by and references these excellent open source projects:
90+
91+
- [svn-scm](https://github.com/JohnstonCode/svn-scm) - SVN source control management for VSCode
92+
- [vscode](https://github.com/microsoft/vscode) - Visual Studio Code editor
93+
- [vscode-gitlens](https://github.com/gitkraken/vscode-gitlens) - Git supercharged for VSCode
94+
- [dish-ai-commit](https://github.com/Sitoi/dish-ai-commit) - AI assisted Git commit message generation
95+
96+
## 📄 License
97+
98+
This project is [MIT](./LICENSE) licensed.
99+
100+
<!-- LINK GROUP -->
101+
102+
[github-codespace-link]: https://codespaces.new/littleCareless/dish-ai-commit
103+
[github-codespace-shield]: https://github.com/littleCareless/dish-ai-commit/blob/main/images/codespaces.png?raw=true
104+
[github-contributors-link]: https://github.com/littleCareless/dish-ai-commit/graphs/contributors
105+
[github-contributors-shield]: https://img.shields.io/github/contributors/littleCareless/dish-ai-commit?color=c4f042&labelColor=black&style=flat-square
106+
[github-forks-link]: https://github.com/littleCareless/dish-ai-commit/network/members
107+
[github-forks-shield]: https://img.shields.io/github/forks/littleCareless/dish-ai-commit?color=8ae8ff&labelColor=black&style=flat-square
108+
[github-issues-link]: https://github.com/littleCareless/dish-ai-commit/issues
109+
[github-issues-shield]: https://img.shields.io/github/issues/littleCareless/dish-ai-commit?color=ff80eb&labelColor=black&style=flat-square
110+
[github-license-link]: https://github.com/littleCareless/dish-ai-commit/blob/main/LICENSE
111+
[github-license-shield]: https://img.shields.io/github/license/littleCareless/dish-ai-commit?color=white&labelColor=black&style=flat-square
112+
[github-stars-link]: https://github.com/littleCareless/dish-ai-commit/network/stargazers
113+
[github-stars-shield]: https://img.shields.io/github/stars/littleCareless/dish-ai-commit?color=ffcb47&labelColor=black&style=flat-square
114+
[pr-welcome-link]: https://github.com/littleCareless/dish-ai-commit/pulls
115+
[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
116+
[github-contrib-link]: https://github.com/littleCareless/dish-ai-commit/graphs/contributors
117+
[github-contrib-shield]: https://contrib.rocks/image?repo=littleCareless%2Fdish-ai-commit
118+
[vscode-marketplace-link]: https://marketplace.visualstudio.com/items?itemName=littleCareless.dish-ai-commit
119+
[vscode-marketplace-shield]: https://img.shields.io/vscode-marketplace/v/littleCareless.dish-ai-commit.svg?label=vscode%20marketplace&color=blue&labelColor=black&style=flat-square
120+
[total-installs-link]: https://marketplace.visualstudio.com/items?itemName=littleCareless.dish-ai-commit
121+
[total-installs-shield]: https://img.shields.io/vscode-marketplace/d/littleCareless.dish-ai-commit.svg?&color=greeen&labelColor=black&style=flat-square
122+
[avarage-rating-link]: https://marketplace.visualstudio.com/items?itemName=littleCareless.dish-ai-commit
123+
[avarage-rating-shield]: https://img.shields.io/vscode-marketplace/r/littleCareless.dish-ai-commit.svg?&color=green&labelColor=black&style=flat-square

‎README.zh-CN.md

+68-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
1-
# Dish AI Commit Gen
1+
<div align="center">
2+
3+
<h1>Dish AI Commit Gen</h1>
4+
5+
用 AI 辅助生成规范的 Git/SVN 提交信息的 VSCode 扩展
6+
7+
[报告错误][github-issues-link] · [请求功能][github-issues-link]
8+
<!-- SHIELD GROUP -->
9+
10+
[![][github-contributors-shield]][github-contributors-link]
11+
[![][github-forks-shield]][github-forks-link]
12+
[![][github-stars-shield]][github-stars-link]
13+
[![][github-issues-shield]][github-issues-link]
14+
[![][vscode-marketplace-shield]][vscode-marketplace-link]
15+
[![][total-installs-shield]][total-installs-link]
16+
[![][avarage-rating-shield]][avarage-rating-link]
17+
[![][github-license-shield]][github-license-link]
18+
19+
![演示](images/demo.gif)
20+
21+
</div>
222

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

@@ -32,13 +52,15 @@
3252

3353
### 配置项
3454

35-
- `dish-ai-commit.PROVIDER`: AI 提供商选择 (openai/ollama/vscode)
36-
- `dish-ai-commit.MODEL`: 使用的 AI 模型
37-
- `dish-ai-commit.OPENAI_API_KEY`: OpenAI API 密钥
38-
- `dish-ai-commit.OPENAI_BASE_URL`: OpenAI API 基础地址
39-
- `dish-ai-commit.OLLAMA_BASE_URL`: Ollama API 地址
40-
- `dish-ai-commit.AI_COMMIT_LANGUAGE`: 生成提交信息的语言
41-
- `dish-ai-commit.AI_COMMIT_SYSTEM_PROMPT`: 自定义系统提示词
55+
| 配置项 | 类型 | 默认值 | 必填 |
56+
|--------|------|--------|------|
57+
| dish-ai-commit.AI_COMMIT_LANGUAGE | string | Simplified Chinese | 是 |
58+
| dish-ai-commit.AI_COMMIT_SYSTEM_PROMPT | string | "" | 否 |
59+
| dish-ai-commit.provider | string | OpenAI | 是 |
60+
| dish-ai-commit.model | string | gpt-3.5-turbo | 是 |
61+
| dish-ai-commit.openai.apiKey | string | - | 是 |
62+
| dish-ai-commit.openai.baseUrl | string | https://api.openai.com/v1 | 否 |
63+
| dish-ai-commit.ollama.baseUrl | string | http://localhost:11434 | 否 |
4264

4365
### 命令
4466

@@ -79,7 +101,7 @@
79101
- 从源代码管理器中选择要提交的文件
80102
- 点击源代码管理器标题栏中的"Dish AI Commit"图标
81103
- 或在命令面板中执行"Dish AI Commit"命令
82-
- AI 将自动生成符合规范��提交信息
104+
- AI 将自动生成符合规范的提交信息
83105

84106
## 📥 安装
85107

@@ -144,6 +166,42 @@
144166
- [ ] **🔒 安全性功能**
145167
加密存储 API 密钥，确保敏感信息不被泄露，并提供额外的身份验证机制来提高安全性。
146168

169+
## 🙏 致谢
170+
171+
本项目参考了以下优秀的开源项目：
172+
173+
- [svn-scm](https://github.com/JohnstonCode/svn-scm) - VSCode 的 SVN 源代码管理扩展
174+
- [vscode](https://github.com/microsoft/vscode) - Visual Studio Code 编辑器
175+
- [vscode-gitlens](https://github.com/gitkraken/vscode-gitlens) - VSCode 的 Git 增强扩展
176+
- [ai-commit](https://github.com/Sitoi/ai-commit) - AI 辅助生成 Git 提交信息
177+
147178
## 📄 许可证
148179

149-
MIT License
180+
该项目是 [MIT](./LICENSE) 许可证。
181+
182+
183+
184+
<!-- LINK GROUP -->
185+
186+
[github-codespace-link]: https://codespaces.new/littleCareless/dish-ai-commit
187+
[github-codespace-shield]: https://github.com/littleCareless/dish-ai-commit/blob/main/images/codespaces.png?raw=true
188+
[github-contributors-link]: https://github.com/littleCareless/dish-ai-commit/graphs/contributors
189+
[github-contributors-shield]: https://img.shields.io/github/contributors/littleCareless/dish-ai-commit?color=c4f042&labelColor=black&style=flat-square
190+
[github-forks-link]: https://github.com/littleCareless/dish-ai-commit/network/members
191+
[github-forks-shield]: https://img.shields.io/github/forks/littleCareless/dish-ai-commit?color=8ae8ff&labelColor=black&style=flat-square
192+
[github-issues-link]: https://github.com/littleCareless/dish-ai-commit/issues
193+
[github-issues-shield]: https://img.shields.io/github/issues/littleCareless/dish-ai-commit?color=ff80eb&labelColor=black&style=flat-square
194+
[github-license-link]: https://github.com/littleCareless/dish-ai-commit/blob/main/LICENSE
195+
[github-license-shield]: https://img.shields.io/github/license/littleCareless/dish-ai-commit?color=white&labelColor=black&style=flat-square
196+
[github-stars-link]: https://github.com/littleCareless/dish-ai-commit/network/stargazers
197+
[github-stars-shield]: https://img.shields.io/github/stars/littleCareless/dish-ai-commit?color=ffcb47&labelColor=black&style=flat-square
198+
[pr-welcome-link]: https://github.com/littleCareless/dish-ai-commit/pulls
199+
[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
200+
[github-contrib-link]: https://github.com/littleCareless/dish-ai-commit/graphs/contributors
201+
[github-contrib-shield]: https://contrib.rocks/image?repo=littleCareless%2Fdish-ai-commit
202+
[vscode-marketplace-link]: https://marketplace.visualstudio.com/items?itemName=littleCareless.dish-ai-commit
203+
[vscode-marketplace-shield]: https://img.shields.io/vscode-marketplace/v/littleCareless.dish-ai-commit.svg?label=vscode%20marketplace&color=blue&labelColor=black&style=flat-square
204+
[total-installs-link]: https://marketplace.visualstudio.com/items?itemName=littleCareless.dish-ai-commit
205+
[total-installs-shield]: https://img.shields.io/vscode-marketplace/d/littleCareless.dish-ai-commit.svg?&color=greeen&labelColor=black&style=flat-square
206+
[avarage-rating-link]: https://marketplace.visualstudio.com/items?itemName=littleCareless.dish-ai-commit
207+
[avarage-rating-shield]: https://img.shields.io/vscode-marketplace/r/littleCareless.dish-ai-commit.svg?&color=green&labelColor=black&style=flat-square

0 commit comments

Comments
 (0)