Files
social-app/docs/rules/repo-structure.md
T

743 B
Raw Blame History

目录结构规则

顶层目录(必须遵守)

仓库根目录只能包含以下目录:

  • apps/ —— 可运行应用(Flutter / FastAPI / Worker
  • infra/ —— 基础设施(本地 docker / 云部署 / 迁移)
  • configs/ —— 配置规范与公共配置模板(不含密钥)
  • tools/ —— 脚本与生成器
  • docs/ —— 文档与规则
  • .github/(可选,用于 CI/CD
  • README.md
  • Makefile(可选)

禁止事项

  • 禁止在根目录直接出现:backend/ui/docker/scripts/ 等非规范目录
  • 所有业务代码必须放在 apps/ 目录下
  • 所有配置文件必须放在 configs/ 目录下
  • 所有基础设施相关代码必须放在 infra/ 目录下