1.1 KiB
1.1 KiB
项目协作与开发规范
1. 文档入口
- 项目背景:
CONTEXT.md - 当前状态:
PROJECT_STATE.md - 项目文档索引:
docs/README.md或项目自定义索引 - 通用开发规范:按项目实际路径填写
2. 工作方式
- 先确认目标、边界和验收标准,再改代码或文档。
- 每次只做一个明确 checkpoint。
- 不修改与当前任务无关的用户变更。
- 不回滚用户自己的改动,除非用户明确要求。
- 遇到不确定的技术栈、接口契约、权限边界或数据模型,先确认再继续。
3. 文档更新原则
完成 Feature 后必须检查:
- Domain 是否需要更新。
- Architecture 是否需要更新。
- Workflow 是否需要更新。
- ADR 是否需要新增。
- Spec 是否需要更新状态。
- Project State 是否需要更新。
如果没有变化,明确说明:
No documentation changes required.
4. 测试与验证
- 修改后运行对应模块已有检查命令。
- 如果检查命令尚未配置或因环境问题无法运行,必须明确说明原因。
- 不假装测试通过。