Overview Version History Q & A Rating & Review
一个AI驱动的VSCode插件，使用VSCode内置AI工具分析Git变更并生成经过AI润色的提交说明。
功能特点
🤖 VSCode内置AI ：使用VSCode内置的AI工具分析代码变更并生成高质量的提交说明
📝 上下文分析 ：深入分析代码结构和变更内容，生成更准确的说明
🌍 多语言支持 ：支持中文和英文提交说明
📊 可视化界面 ：在VSCode侧边栏中直观显示待提交文件和生成的说明
⚡ 一键操作 ：快速生成、复制提交说明
🔒 无需第三方API ：不需要配置任何第三方API密钥，完全使用VSCode内置AI能力
安装
在VSCode扩展市场中搜索 "Git Comment Generator"
点击安装
重启VSCode
使用方法
基本使用
在Git仓库中进行代码修改
将修改的文件添加到暂存区 (git add 命令)
在VSCode侧边栏的"源代码管理"面板中找到"Git提交说明"视图
点击"生成提交说明"按钮
等待VSCode内置AI分析并生成提交说明
查看生成的说明，可以点击"复制提交说明"按钮复制到剪贴板
命令面板
你也可以通过命令面板使用插件功能：
打开命令面板 (Ctrl+Shift+P 或 Cmd+Shift+P)
输入 "Git Comment Generator" 查看可用命令
选择 "生成Git提交说明" 执行功能
配置
插件支持以下配置选项，可以在VSCode设置中进行修改：
gitCommentGenerator.language: 生成说明的语言 (zh-CN, en-US)gitCommentGenerator.includeContext: 是否包含代码上下文分析 (默认: true)
注意：本插件使用VSCode内置AI工具，不需要配置任何API密钥或端点。
工作原理
获取Git变更 ：插件首先获取当前Git仓库中暂存区的文件变更代码分析 ：分析代码结构，识别函数、类、导入等元素上下文理解 ：理解代码变更的目的和影响VSCode内置AI生成 ：将分析结果发送给VSCode内置AI工具，生成润色的提交说明结果展示 ：在VSCode中展示生成的提交说明
示例
生成的中文提交说明示例
feat: 添加用户认证功能
- 新增用户登录和注册API
- 实现JWT令牌验证机制
- 添加用户权限检查中间件
- 更新用户模型以支持密码加密
这些变更使应用程序能够安全地管理用户身份验证和授权，
提高了系统的安全性和用户体验。
生成的英文提交说明示例
feat: add user authentication functionality
- Add user login and registration APIs
- Implement JWT token verification mechanism
- Add user permission check middleware
- Update user model to support password encryption
These changes enable the application to securely manage user
authentication and authorization, improving system security
and user experience.
故障排除
常见问题
"VSCode AI不可用"错误
确保你的VSCode版本支持内置AI功能
检查VSCode AI功能是否已启用
"没有找到待提交的文件"提示
确保已经将文件添加到Git暂存区
使用git status检查文件状态
生成的提交说明质量不佳
尝试启用"包含代码上下文分析"选项
确保代码变更清晰且有意义
如果VSCode AI工具返回结果不理想，插件会提供基于模板的回退方案
贡献
欢迎提交问题报告和功能请求！如果你想贡献代码，请遵循以下步骤：
Fork这个仓库
创建你的功能分支 (git checkout -b feature/AmazingFeature)
提交你的更改 (git commit -m 'Add some AmazingFeature')
推送到分支 (git push origin feature/AmazingFeature)
打开一个Pull Request
许可证
本项目采用MIT许可证 - 查看 LICENSE 文件了解详情。
更新日志
v0.0.1
初始版本发布
支持基本的Git提交说明生成
使用VSCode内置AI工具
支持中文和英文提交说明
提供VSCode侧边栏界面
无需第三方API密钥配置
