Oh My Commit (Yet Another Auto Commit) - PRD
产品定位
Oh My Commit 是新一代的 Git 提交助手,专注于提供卓越的用户体验和强大的 AI 能力。我们的目标是让每一次代码提交都成为一种享受,而不是负担。
核心优势
极致的用户体验
- 基于 TypeScript + Tailwind CSS 构建的现代化界面
- 响应式设计,完美适配各种屏幕尺寸
- 流畅的动画过渡,提供沉浸式体验
- 键盘优先的操作设计,提升工作效率
强大的 AI 引擎
- 多模型支持架构,灵活切换不同 AI 服务
- 自研的代码理解引擎,深度分析变更内容
- 持续学习的提交优化系统,不断提升质量
- 团队风格适配,保持提交信息一致性
设计理念
- 简单至上:用户无需关心底层技术实现,只需关注结果
- 灵活可选:提供多种提交方案,用户可根据成本、效果、性能自由选择
- 用户友好:支持多行提交信息,方便用户详细描述变更内容
- 一次配置:API 密钥等配置只需设置一次,后续专注于提交体验
目标用户
- 使用 VSCode 的开发者
- 重视代码提交质量的团队
- 希望提高工作效率的个人开发者
核心功能
1. 智能提交(重新设计)
快速提交模式
- 一键式智能提交
- 使用推荐的默认提交方案
- 无需任何额外配置
提交方案选择
- 在状态栏快速切换不同提交方案
- 方案示例:
official_recommend
(官方推荐,平衡性能与成本)gcop_fast
(速度优先)premium_quality
(质量优先)
- 支持用户自定义方案名称
- 显示方案的成本/性能/质量指标
2. 配置管理(重新设计)
API 配置
- 统一的 API 配置界面
- 支持多个服务商的 API 设置
- API 密钥安全存储
- 一键测试 API 可用性
方案管理
- 自定义提交方案
- 重命名已有方案
- 调整方案参数
- 导入/导出方案配置
3. 代码变更分析
- 智能识别重要代码变更
- 支持多文件变更的统一分析
- 识别重构、bugfix、feature 等不同类型的变更
4. 用户交互
- 提供直观的 UI 界面
- 支持快捷键操作
- 提交前预览和编辑功能
- 实时反馈和建议
5. 高级特性
- 支持 Git hooks 集成
- 团队配置共享
- 提交历史分析和建议
- AI 模型可配置(支持自定义 API)
用户界面
1. 状态栏
- 当前选择的提交方案名称
- 快速切换方案的下拉菜单
- 方案性能指标图标(速度/成本/质量)
2. 命令面板
Oh My Commit: Quick Commit
- 使用当前方案快速提交Oh My Commit: Select Model
- 切换提交方案Oh My Commit: Open Preferences
-打开用户配置系统
3. 设置界面
- API 配置分组
- 提交方案管理
- 个性化设置
技术路线
Phase 1 - 基础框架(已完成)
- ✅ 搭建 TypeScript + Tailwind CSS 开发环境
- ✅ 实现基础 UI 组件库
- ✅ 集成 Jotai 状态管理
- ✅ 完成核心提交流程
Phase 2 - 体验优化(进行中)
- 🏃♂️ 优化 UI/UX 设计
- 🏃♂️ 实现快捷键系统
- 🏃♂️ 改进错误处理
Phase 3 - AI 增强(进行中)
- 📅 集成更多 AI 模型
- 📅 优化代码分析算法
- 📅 添加团队学习功能
- 📅 实现自定义训练
Phase 4 - 生态建设(规划中)
- 📅 提供 API 集成
- 📅 建设开发者社区
- 📅 推出企业版本
性能指标
- 快速提交响应时间 < 2s
- 配置切换无延迟
- API 配置过程简单直观
开发里程碑
Phase 1 - MVP(v0.1.0)
- [x] 项目初始化
- [x] 基础 VSCode 插件框架
- [ ] 简单的 AI 提交信息生成
- [x] 基础 UI 界面
Phase 2 - 核心功能(v0.2.0)
- [ ] 完整的代码分析系统
- [ ] 多种提交格式支持
- [x] 用户配置系统
- [ ] 提交历史分析
Phase 3 - 高级特性(v0.3.0)
- [ ] 团队功能
- [x] CI/CD 集成
- [ ] 性能优化
- [ ] 多语言支持完善
成功指标
- 用户满意度 > 4.5/5
- VSCode 商店评分 > 4.8/5
- 月活用户 > 10,000
- 提交信息采纳率 > 80%