31 lines
1.4 KiB
Markdown
31 lines
1.4 KiB
Markdown
|
# 蚊子项目开发宪章
|
|||
|
|
|
|||
|
|
## 核心原则
|
|||
|
|
|
|||
|
|
### I. 测试驱动开发 (TDD)
|
|||
|
|
所有新功能在实现前，都必须先编写并通过用户认可的单元测试和集成测试。严格遵循红-绿-重构的开发循环。
|
|||
|
|
|
|||
|
|
### II. API 优先 (API First)
|
|||
|
|
所有功能实现应从API设计开始。在进行后端实现之前，应使用如OpenAPI的格式先完成API的设计和文档编写，并获得审查通过。
|
|||
|
|
|
|||
|
|
### III. 关注点分离 (Separation of Concerns)
|
|||
|
|
前后端代码应保持严格分离，通过定义好的API契约进行交互。这使得两者可以独立开发、测试和部署。
|
|||
|
|
|
|||
|
|
### IV. 代码整洁 (Clean Code)
|
|||
|
|
代码应遵循Google Java风格指南，保持高度的可读性和可维护性。所有公开的API和复杂的业务逻辑必须有清晰的JavaDoc文档。
|
|||
|
|
|
|||
|
|
## 开发工作流
|
|||
|
|
|
|||
|
|
所有开发工作都应遵循`spec-kit`定义的规范驱动开发流程。
|
|||
|
|
1. 使用 `/specify` 创建功能规范。
|
|||
|
|
2. 使用 `/plan` 制定实施计划。
|
|||
|
|
3. 使用 `/tasks` 生成开发任务。
|
|||
|
|
4. 通过 `/tasks start <编号>` 开始任务，并提交代码。
|
|||
|
|
5. 所有代码变更必须通过Pull Request进行，并由至少一名其他团队成员审查。
|
|||
|
|
|
|||
|
|
## 治理
|
|||
|
|
|
|||
|
|
本宪章是项目开发的最高准则，其优先级高于所有其他实践或个人偏好。对宪章的任何修订都必须经过团队讨论、记录在案，并获得批准。
|
|||
|
|
|
|||
|
|
**版本**: 1.0 | **批准日期**: 2025-09-29 | **上次修订日期**: 2025-09-29
|