1.5 KiB
1.5 KiB
可复用迁移规范索引
1. 文档定位
本目录保存可复制到后续新项目的通用开发规范和技术边界文档。
新项目初始化时,可以复制整个 docs/import/reusable/ 目录,再根据项目实际情况调整根目录 AGENTS.md 的引用路径和项目补充规则。不需要的 integrations/ 文档可以删除。
2. 文档清单
general-development-guidelines.md:通用开发协作规范。frontend-development-guidelines.md:通用前端开发规范,不包含具体业务项目规则。backend-development-guidelines.md:通用后端开发规范,不包含具体业务项目规则。backend-base-structure-pagination-guidelines.md:后端基础结构、ID、审计字段、分页和 Mapper 规范。alibaba-java-coding-guidelines-summary.md:Alibaba Java Coding Guidelines 摘要。integrations/superagent-agentbus-portable-integration-guide.md:SuperAgent 与 AgentBus 可移植对接指南,只有需要类似集成时才复制。
3. 使用方式
复制到新项目后,建议先确认:
- 新项目是否仍使用
client/和server/目录。 - 后端是否仍使用 Java、Spring Boot、MyBatis-Plus 和 MySQL。
- 前端是否仍使用 Vue、TypeScript、Vite 和 PrimeVue。
- 是否需要 SuperAgent、AgentBus 或其他外部系统接入。
- 根目录
AGENTS.md是否已经引用本目录下的规范。 - 当前项目专属业务规则是否已经放在项目自己的文档目录,而不是混入本目录。