Skip to content

Commit

Permalink
📝 docs(changelog): 发布 0.3.0 版本并更新文档
Browse files Browse the repository at this point in the history
- 更新 CHANGELOG 添加 0.3.0 版本的更新记录
- 更新英文和中文文档,新增 Gemini AI 和周报功能说明
- 更新版本号至 0.3.0
- 修正 package.json 和 package-lock.json 的版本信息
  • Loading branch information
littleCareless committed Dec 13, 2024
1 parent 02b00fc commit cd0f05e
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 6 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)

# 0.3.0 (2024-12-13)

### ✨ Features

- **weekly**: 添加 AI 生成周报功能 ([b557c7a](https://github.com/littleCareless/dish-ai-commit/commit/b557c7a))
- **weeklyReport**: 添加生成周报的功能 ([04e999e](https://github.com/littleCareless/dish-ai-commit/commit/04e999e))

### 🎫 Chores

- **config**: 重构周报功能并添加 Gemini AI 支持 ([02b00fc](https://github.com/littleCareless/dish-ai-commit/commit/02b00fc))
- **release**: 发布 0.2.0 版本 ([29e89ce](https://github.com/littleCareless/dish-ai-commit/commit/29e89ce))

# 0.2.0 (2024-12-12)

### ♻ Code Refactoring
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@

更新日志格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)

# 0.3.0 (2024-12-13)

### ✨ Features

- **weekly**: 添加 AI 生成周报功能 ([b557c7a](https://github.com/littleCareless/dish-ai-commit/commit/b557c7a))
- **weeklyReport**: 添加生成周报的功能 ([04e999e](https://github.com/littleCareless/dish-ai-commit/commit/04e999e))

### 🎫 Chores

- **config**: 重构周报功能并添加 Gemini AI 支持 ([02b00fc](https://github.com/littleCareless/dish-ai-commit/commit/02b00fc))
- **release**: 发布 0.2.0 版本 ([29e89ce](https://github.com/littleCareless/dish-ai-commit/commit/29e89ce))

# 0.2.0 (2024-12-12)

### ♻ Code Refactoring
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ A VSCode extension for generating standardized Git/SVN commit messages using AI

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

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.
A VSCode extension for generating standardized Git/SVN commit messages using AI. Supports OpenAI, Ollama, VSCode built-in AI services, Zhipu AI, DashScope, Gemini AI, and Doubao AI.

## Features

Expand All @@ -35,12 +35,20 @@ A VSCode extension for generating standardized Git/SVN commit messages using AI.
- Zhipu AI support
- DashScope support
- Doubao AI support
- Gemini AI support

### 📝 Version Control System Support

- SVN
- Git

### 📊 Weekly Report Generation

- AI-powered weekly report generation
- Automatically summarize your work progress
- Customizable report templates
- Support multiple AI providers for report generation

### 🌍 Multi-language Commit Message Generation:

Supports 19 languages including:
Expand Down Expand Up @@ -76,6 +84,7 @@ Supports 19 languages including:
| dish-ai-commit.zhipuai.apiKey | string | - | Zhipu AI API key |
| dish-ai-commit.dashscope.apiKey | string | - | DashScope API key |
| dish-ai-commit.doubao.apiKey | string | - | Doubao API key |
| dish-ai-commit.gemini.apiKey | string | - | Gemini API key |
| dish-ai-commit.ollama.baseUrl | string | http://localhost:11434 | Ollama API base URL |
| dish-ai-commit.enableDiffSimplification | boolean | false | Enable diff content simplification |
| dish-ai-commit.diffSimplification.maxLineLength | number | 120 | Maximum line length after simplification |
Expand All @@ -86,6 +95,7 @@ Supports 19 languages including:

- `Generate Commit Message`: Generate commit message based on current changes
- `Select AI Model`: Choose the AI model to use
- `Generate Weekly Report`: Generate a weekly summary report of your work

## Configuration Instructions

Expand Down
19 changes: 18 additions & 1 deletion README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

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

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

## 功能特性

Expand All @@ -35,6 +35,7 @@
- 智谱 AI 支持
- DashScope 支持
- 豆包 AI 支持
- Gemini AI 支持

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

Expand All @@ -54,6 +55,12 @@

### 😄 自动添加 emoji 表情

### 📅 工作周报生成

- 支持自动生成工作周报
- 基于提交历史智能总结
- 可自定义周报模板和格式

### 配置项

| 配置项 | 类型 | 默认值 | 说明 |
Expand All @@ -68,6 +75,7 @@
| dish-ai-commit.dashscope.apiKey | string | - | DashScope API 密钥 |
| dish-ai-commit.doubao.apiKey | string | - | 豆包 API 密钥 |
| dish-ai-commit.ollama.baseUrl | string | http://localhost:11434 | Ollama API 基础 URL |
| dish-ai-commit.gemini.apiKey | string | - | Gemini AI API 密钥 |
| dish-ai-commit.enableDiffSimplification | boolean | false | 启用 diff 内容简化功能 |
| dish-ai-commit.diffSimplification.maxLineLength | number | 120 | 简化后每行的最大长度 |
| dish-ai-commit.diffSimplification.contextLines | number | 3 | 保留上下文行数 |
Expand Down Expand Up @@ -107,6 +115,15 @@
}
```

4. Gemini AI 配置

```json
{
"dish-ai-commit.PROVIDER": "gemini",
"dish-ai-commit.GEMINI_API_KEY": "your-api-key"
}
```

## 📋 使用方法

- 从源代码管理器中选择要提交的文件
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "dish-ai-commit",
"displayName": "Dish AI Commit Gen",
"description": "Use AI to assist in generating standardized Git/SVN submission information VSCode extensions. Support OpenAI, Olama, and VSCode built-in AI services.",
"version": "0.2.0",
"version": "0.3.0",
"engines": {
"vscode": "^1.95.0"
},
Expand Down Expand Up @@ -307,4 +307,4 @@
]
}
}
}
}

0 comments on commit cd0f05e

Please sign in to comment.