二、项目结构与版本控制规范

🧱 二、项目结构与版本控制规范

2.1 背景

项目结构和版本控制，是团队协作的地基。
一个混乱的目录结构、随意的Git提交或冲突的分支策略，会让整个团队陷入低效与混乱。

因此，我们要求：

“任何团队成员，都应能在 10 分钟内理解项目结构，
并在 5 分钟内完成一次标准化提交。”

---

2.2 项目结构规范（Project Structure）

2.2.1 目录分层原则

遵循 高内聚、低耦合 的设计原则，所有项目目录应结构清晰、职责单一。
推荐的通用目录结构如下（语言无关）：

project-root/
│
├── src/              # 源代码目录（核心业务逻辑）
│   ├── main/          # 主程序入口或主模块
│   ├── module_a/      # 子模块（按功能划分）
│   └── utils/         # 工具类、通用函数
│
├── tests/            # 单元测试与集成测试
│   └── test_module_a/
│
├── config/           # 配置文件（环境区分）
│   ├── dev/
│   ├── test/
│   └── prod/
│
├── scripts/          # 自动化脚本（构建、部署、数据迁移）
│
├── docs/             # 技术文档与接口说明
│
├── .gitignore        # Git忽略文件规则
├── requirements.txt  # Python依赖文件（或package.json / pom.xml）
└── README.md         # 项目说明

✅