EE308FZ_Fifth Assignment_Code standards, Current Sprint Tasks, and Plans

本文介绍了团队开发LumiTap项目的代码规范与冲刺计划。项目采用Git分支策略，包含main、dev、feature和hotfix分支，要求PR审核合并。代码规范遵循PEP8(Python)、Vue官方准则等，后端使用Flask框架，前端基于Vue3+ElementPlus。冲刺目标是在10天内完成核心功能开发，包括用户登录、谱面解析、播放器逻辑等，并产出可运行演示。计划按日分解任务，从项目初始

嘻嘻，我一定要成为最强炼丹师

520人浏览 · 2025-12-12 23:34:41

嘻嘻，我一定要成为最强炼丹师 · 2025-12-12 23:34:41 发布

1.格式说明

本次作业的课程	EE308FZ(软件工程)
作业要求	作业5
目标	阐述团队的代码规范、当前的冲刺任务以及计划
其他参考文献	Python PEP8,Vue官方准则,ESLint代码规范,阿里巴巴Java开发手册,华为编程规范

2.总体开发流程与版本控制规范

分支策略:

main: 发布/演示版（仅合并经 PR 审核通过的代码）
dev: 每日集成主线（功能合并后先合到 dev）
feature/<ISSUE#>-<简短名>: 每个 Issue 对应一个分支
hotfix/<id>: 紧急修复

合并与审核:

所有代码通过 PR 合并，至少 1 名同组成员进行检查
PR 必须包含：变更说明、关联 Issue、Testing 说明、影响范围

Commit / PR 规范
Commit message 模板：

<type>(<scope>): <简短说明> #<issue-number>

type 可以为：feat / fix / docs / refactor / test / chore
示例:

feat(auth): add login API with JWT #32
fix(ui): adjust result page layout #36

3.语言/框架代码规范

3.1 后端 (Python / Flask)

遵守 PEP8；使用 flake8 做静态检查，black 做格式化
命名：模块/文件 snake_case，类 PascalCase，函数/变量 snake_case
每个公开函数/方法需补充 docstring；复杂逻辑写清注释或单元测试
异常处理：统一 error handler，返回标准 JSON（{code,msg,data}）
配置：使用环境变量（.env），敏感信息不入库

3.2 前端 (Vue3 + ElementPlus)

使用 ESLint + Prettier，保存时自动格式化
组件命名及文件命名均使用PascalCase命名法
组件职责单一化，避免过大的单文件组件（SFC）
所有网络请求需处理错误并显示友好提示
重要交互（上传、保存）需有 loading 与错误回滚策略

4.Issue / PR / Commit 证据规范

若成员角色为开发：必须保有 code check-ins（commit/PR），并提供对应 Issue 的内容与链接、以及 commit/PR 的链接或截图
若成员角色为测试/其他：必须提供具体结果（测试报告、截图、日志、设计稿等）

5.最低安全、依赖与部署要求

requirements.txt（后端）与 package.json（前端）必须准确列出依赖版本并提交到仓库
私有信息（API Key 等）不得提交到仓库；使用 .env.example 提示配置项

6.本次冲刺目标与Issue 列表

冲刺目标: 完成 LumiTap 的基本可玩功能（前端播放 & 点击判定、后端谱面解析/存储、用户登录/历史存储、演示 Demo）并产出至少 1 个可运行演示与最终的完整 Sprint Blog

Task Backlog

Issue	任务	重要性系数
#1	初始化仓库与项目配置（CI/ESLint/black/pre-commit）	3
#2	用户注册/登录（JWT）	1
#3	文件上传 API（解析 JSON 谱面）	3
#4	播放器核心逻辑（前端 4x4 点击判定）	6
#5	结果计分与排行榜展示	1
#6	前端谱面上传页/选择页	1
#7	单元测试（后端）与 CI 报告	3
#8	前端自动化测试（交互）	1
#9	演示视频 / Demo 文档	1
#10	博客（Code Standards）与 Sprint Essays 模板	3

7.冲刺计划

时间窗: 2025-12-12 — 2025-12-21

日	主要任务	验收标准
Day1(12-12)	项目初始化, CI & lint & pre-commit, Issue 列表整理	`main`/`dev` 分支，Issue 列表，CI badge，PR 模板 screenshot
Day2(12-13)	用户登录/注册接口	登录注册 API 文档 + 自动化测试 + commit/PR
Day3(12-14)	文件上传 API（解析 JSON 谱面）	上传接口可接受谱面 JSON，返回 success；对应测试
Day4(12-15)	前端播放核心（点击判定）	本地 demo 可运行,正确判定great,good,miss
Day5(12-16)	计分及排行榜	分数计算逻辑说明，DB 存储样例，前端展示
Day6(12-17)	上传/选择界面完成	前端上传页面、显示上传结果
Day7(12-18)	后端单元测试覆盖重要逻辑	测试报告截图/CI artifact
Day8(12-19)	前端自动化/手动回归测试	UI 测试报告 + Bug fix
Day9(12-20)	部署	可以正常游玩，核心功能正常实施
Day10(12-21)	冲刺总结、博客提交	Topical Collection 更新，全部证据整理并提交链接