Skip to content

Commit 95c32f3

Browse files
committed
更新v0.4.0版本文档
- 更新README.md版本号和更新时间 - 添加v0.4.0新功能说明(历史记录、编辑模态框、滚动修复) - 创建v0.4.0发布说明文档 - 更新项目状态和进度信息
1 parent 9a0ee2d commit 95c32f3

File tree

2 files changed

+212
-3
lines changed

2 files changed

+212
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
基于Go + Gin + GORM和Vue3 + TypeScript + Ant Design Vue的全栈项目管理软件。
44

5-
**当前版本**: v0.3.0
6-
**最后更新**: 2025年11月26日
5+
**当前版本**: v0.4.0
6+
**最后更新**: 2025年11月27日
77

8-
> 📦 [v0.3.0 发布说明](./docs/v0.3.0发布说明.md) | [开发计划](./docs/开发计划.md) | [API文档](./docs/API设计文档.md)
8+
> 📦 [v0.4.0 发布说明](./docs/v0.4.0发布说明.md) | [开发计划](./docs/开发计划.md) | [API文档](./docs/API设计文档.md)
99
1010
## 技术栈
1111

@@ -148,6 +148,18 @@ project/
148148
- ✅ 项目详情页优化
149149
- ✅ 修复页面滚动问题
150150
- ✅ 项目描述支持Markdown格式渲染显示
151+
- ✅ 历史记录功能(v0.4.0)
152+
- ✅ 为项目、需求、任务、Bug、版本详情页面添加历史记录
153+
- ✅ 支持查看操作历史(创建、编辑、分配、解决等)
154+
- ✅ 支持添加备注
155+
- ✅ 历史记录详情可折叠展开
156+
- ✅ 编辑模态框优化(v0.4.0)
157+
- ✅ 详情页面的"编辑"按钮直接弹出编辑模态框
158+
- ✅ 无需跳转页面即可编辑
159+
- ✅ 支持Markdown编辑器中的图片上传
160+
- ✅ 详情页面滚动修复(v0.4.0)
161+
- ✅ 修复所有详情页面的滚动问题
162+
- ✅ 统一页面样式和交互体验
151163

152164
## 项目状态
153165

@@ -169,12 +181,29 @@ project/
169181
- ✅ 需求、任务、Bug迁移
170182
- ✅ 项目成员迁移
171183
12.**通用组件封装** - 模块管理组件封装为通用组件(v0.3.0)
184+
13.**历史记录系统** - 完整的操作历史记录和备注功能(v0.4.0)
185+
- ✅ 项目、需求、任务、Bug、版本操作历史记录
186+
- ✅ 字段变更详情记录和显示
187+
- ✅ 手动添加备注功能
188+
- ✅ 历史记录可折叠展开
189+
14.**编辑模态框优化** - 详情页面直接编辑功能(v0.4.0)
190+
- ✅ 所有详情页面支持模态框编辑
191+
- ✅ 无需跳转即可完成编辑操作
192+
- ✅ 提升用户体验和操作效率
172193

173194
### 进行中 ⏳
174195

175196
- 单元测试补充(各模块测试覆盖率提升至100%)
176197
- 禅道数据迁移工具完善(支持更多数据类型的迁移)
177198

199+
### v0.4.0 更新内容(2025年11月27日)
200+
201+
- ✅ 历史记录功能:为项目、需求、任务、Bug、版本详情页面添加完整的操作历史记录
202+
- ✅ 编辑模态框:详情页面支持直接弹出编辑模态框,无需跳转
203+
- ✅ 滚动修复:修复所有详情页面的滚动问题,统一用户体验
204+
- ✅ 备注功能:支持在历史记录中添加备注
205+
- ✅ 字段变更追踪:详细记录和显示字段变更历史
206+
178207
### 待开发功能 📋
179208

180209
1. **插件管理系统** - 插件安装、配置、前端界面支持、插件市场

docs/v0.4.0发布说明.md

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
# v0.4.0 发布说明
2+
3+
**发布日期**: 2025年11月27日
4+
5+
## 版本概述
6+
7+
v0.4.0 版本主要聚焦于用户体验优化和操作历史追踪功能,为项目、需求、任务、Bug、版本等核心模块添加了完整的操作历史记录功能,并优化了编辑操作的交互方式。
8+
9+
## 主要功能
10+
11+
### 1. 历史记录功能 ✨
12+
13+
为所有核心模块的详情页面添加了完整的操作历史记录功能:
14+
15+
- **操作记录**:自动记录所有操作(创建、编辑、分配、解决、确认等)
16+
- **字段变更追踪**:详细记录每个字段的变更(旧值 → 新值)
17+
- **备注功能**:支持手动添加备注,记录重要信息
18+
- **可折叠显示**:历史记录详情支持展开/收起,界面更简洁
19+
- **时间线展示**:使用时间线组件展示历史记录,清晰直观
20+
21+
**支持的模块**
22+
- ✅ 项目详情页面
23+
- ✅ 需求详情页面
24+
- ✅ 任务详情页面
25+
- ✅ Bug详情页面
26+
- ✅ 版本详情页面
27+
28+
### 2. 编辑模态框优化 🎨
29+
30+
优化了所有详情页面的编辑操作体验:
31+
32+
- **直接编辑**:点击"编辑"按钮直接弹出编辑模态框,无需跳转页面
33+
- **数据预填充**:编辑模态框自动填充当前数据
34+
- **图片上传**:Markdown编辑器中的图片支持自动上传
35+
- **实时更新**:编辑完成后自动刷新详情页面和历史记录
36+
37+
**优化的页面**
38+
- ✅ 项目详情页面
39+
- ✅ 需求详情页面
40+
- ✅ 任务详情页面
41+
- ✅ Bug详情页面
42+
- ✅ 版本详情页面
43+
44+
### 3. 滚动问题修复 🔧
45+
46+
修复了所有详情页面的滚动问题:
47+
48+
- **统一滚动样式**:所有详情页面使用统一的滚动样式
49+
- **固定高度布局**:使用flex布局确保页面正确滚动
50+
- **响应式适配**:适配不同屏幕尺寸
51+
52+
**修复的页面**
53+
- ✅ 项目详情页面
54+
- ✅ 需求详情页面
55+
- ✅ 任务详情页面
56+
- ✅ Bug详情页面
57+
- ✅ 版本详情页面
58+
59+
## 技术实现
60+
61+
### 后端
62+
63+
1. **历史记录数据模型**
64+
- `Action` 表:记录操作信息(操作类型、操作人、备注等)
65+
- `History` 表:记录字段变更详情(字段名、旧值、新值等)
66+
67+
2. **历史记录工具函数**`backend/internal/utils/action.go`
68+
- `RecordAction`:记录操作
69+
- `CompareAndRecord`:比较对象并记录字段变更
70+
- `ProcessHistory`:格式化历史记录显示
71+
72+
3. **API接口**
73+
- `GET /api/projects/:id/history` - 获取项目历史记录
74+
- `POST /api/projects/:id/history/note` - 添加项目备注
75+
- `GET /api/requirements/:id/history` - 获取需求历史记录
76+
- `POST /api/requirements/:id/history/note` - 添加需求备注
77+
- `GET /api/tasks/:id/history` - 获取任务历史记录
78+
- `POST /api/tasks/:id/history/note` - 添加任务备注
79+
- `GET /api/bugs/:id/history` - 获取Bug历史记录
80+
- `POST /api/bugs/:id/history/note` - 添加Bug备注
81+
82+
### 前端
83+
84+
1. **历史记录组件**
85+
- 使用 `a-timeline` 组件展示历史记录
86+
- 支持展开/收起功能
87+
- 字段变更详情格式化显示
88+
89+
2. **编辑模态框**
90+
- 统一的编辑表单组件
91+
- 数据预填充和验证
92+
- 图片上传集成
93+
94+
3. **滚动样式优化**
95+
- 统一的CSS样式
96+
- Flex布局实现
97+
- 响应式适配
98+
99+
## 使用指南
100+
101+
### 查看历史记录
102+
103+
1. 进入任意详情页面(项目、需求、任务、Bug、版本)
104+
2. 在页面底部找到"历史记录"卡片
105+
3. 查看操作历史,点击"展开"查看详细信息
106+
107+
### 添加备注
108+
109+
1. 在历史记录卡片标题右侧,点击"添加备注"按钮
110+
2. 输入备注内容
111+
3. 点击"确定"保存
112+
113+
### 编辑详情
114+
115+
1. 在详情页面顶部,点击"编辑"按钮
116+
2. 在弹出的编辑模态框中修改信息
117+
3. 点击"确定"保存更改
118+
119+
## 更新内容
120+
121+
### 新增文件
122+
123+
- `backend/internal/model/action.go` - 历史记录数据模型
124+
- `backend/internal/utils/action.go` - 历史记录工具函数
125+
- `docs/v0.4.0发布说明.md` - 本发布说明文档
126+
127+
### 修改文件
128+
129+
**后端**
130+
- `backend/cmd/server/main.go` - 添加历史记录API路由
131+
- `backend/internal/api/project.go` - 添加项目历史记录功能
132+
- `backend/internal/api/requirement.go` - 添加需求历史记录功能
133+
- `backend/internal/api/task.go` - 添加任务历史记录功能
134+
- `backend/internal/api/bug.go` - 添加Bug历史记录功能
135+
- `backend/internal/utils/migrate.go` - 添加历史记录表迁移
136+
137+
**前端**
138+
- `frontend/src/api/project.ts` - 添加项目历史记录API
139+
- `frontend/src/api/requirement.ts` - 添加需求历史记录API
140+
- `frontend/src/api/task.ts` - 添加任务历史记录API
141+
- `frontend/src/api/bug.ts` - 添加Bug历史记录API
142+
- `frontend/src/views/project/ProjectDetail.vue` - 添加历史记录和编辑模态框
143+
- `frontend/src/views/requirement/RequirementDetail.vue` - 添加历史记录和编辑模态框
144+
- `frontend/src/views/task/TaskDetail.vue` - 添加历史记录和编辑模态框
145+
- `frontend/src/views/bug/BugDetail.vue` - 优化历史记录和编辑模态框
146+
- `frontend/src/views/version/VersionDetail.vue` - 添加编辑模态框和滚动修复
147+
148+
## 已知问题
149+
150+
151+
152+
## 后续计划
153+
154+
- 继续完善单元测试覆盖率
155+
- 优化历史记录显示性能
156+
- 添加历史记录导出功能
157+
- 支持历史记录搜索和筛选
158+
159+
## 升级指南
160+
161+
### 从 v0.3.0 升级
162+
163+
1. **数据库迁移**:系统会自动创建 `actions``histories`
164+
2. **前端更新**:需要重新构建前端并部署
165+
3. **无破坏性变更**:所有现有功能保持不变
166+
167+
### 注意事项
168+
169+
- 历史记录功能会自动记录所有操作,无需额外配置
170+
- 编辑模态框功能已集成到所有详情页面
171+
- 滚动修复已应用到所有详情页面
172+
173+
## 致谢
174+
175+
感谢所有贡献者的支持和反馈!
176+
177+
---
178+
179+
**下载地址**: [GitHub Releases](https://github.com/funnywwh/goproject/releases/tag/v0.4.0)
180+

0 commit comments

Comments
 (0)