AskaEth
4b35736f73
P0 (5): crypto/rand session ID, TTS fallback可达性, goroutine defer recover, adminAuth前缀修正 P1 (5): 普通用户密码验证, context传递, priority clamp, 超时重试, 自主思考速率限制 P2 (4): Briefing AI降级, 前端消息类型渲染, Docker Compose补全, PWA 192图标 P3 (5): goroutine错误处理, .gitignore完善, reminder created_at, voice Dockerfile, Go版本更新
2.2 KiB
2.2 KiB
项目开发文档管理规范 (修订版)
1. 文档管理目录结构
-
./docs/progress/
请在此目录下定期创建进度md文件，以便后续对话能顺利继承开发进度。 -
./docs/decisions/
请在此目录下创建决策md文件，以便后续对话能准确继承开发决策。 -
./docs/tasks/
请在此目录下为每次任务创建md文件，以便后续对话能回顾开发任务详情。 -
你可以按需求使用或创建其他文档目录。
-
开发前可以通过阅读已有的文档回顾开发进度。
2. 通用文档规范
- 在
./docs/目录下，请按统一格式创建辅助文档或文件夹，便于后续开发参考：
格式：YYYY-MM-DD_HH-mm-SS-topic.md - 每次开启新对话或处理新任务前，建议先浏览这些文件获取上下文。
3. 文档的创建与维护
- 你可以在思考或任务执行过程中，随时新建、修改或删除这些文档，动作可以频繁一些喵~
- 已实现、调试通过且功能完善的模块，请在对应的
md文件中做好统一标记，避免后续频繁重复阅读。 - 在完成功能重大调整与开发后请及时编写或修改
./docs/api-reference/下的文档，和项目根目录下的Deploy.md
4. 调试与测试
- 调试功能时，可以在终端启动
devtools.sh脚本：
使用curl启动所有服务，再通过curl等工具对实现的功能进行接口调试。
devtools提供的 API 可启动各前后端服务，请牢记这个流程喵！
5. 数据库连接
- 开发阶段的数据库连接请使用
scripts/tunnel.sh脚本建立到数据库服务器的连接。
6. 版本提交规范
- 当用户要求的某个功能已完全修复、编写完成并验证成功后，可向当前分支（如
dev）进行推送。 - 禁止提交的内容：
docs/文件夹以及编译后的二进制文件、其他语言环境的依赖和项目临时环境。
7. 测试脚本临时管理
- 在测试长脚本或复杂命令时，可以在项目根目录临时创建
test文件夹，并在其中新建 sh, py 等脚本文件并运行。 - 注意： 用完记得及时删除喵~