vibe前期准备工作指南
在开始使用vibe之前,我们需要进行一些详细的准备工作,以确保整个项目的顺利进行。以下是一个架构的完整目录骨架,每个文件的职责定义,以及后续执行纪律的设计。我们将这些内容保存为一个.md文件作为施工说明书。同时,我们还会创建一个todolist.md文件,用于记录每一步的完成情况,作为后续每一工期的参考。
架构目录骨架
root/
├── src/ # 源代码
│ ├── main.py # 主程序入口
│ ├── utils/ # 工具函数
│ │ ├── helper.py # 辅助函数
│ │ └── config.py # 配置文件
│ └── modules/ # 模块
│ ├── module1.py # 模块1
│ └── module2.py # 模块2
├── tests/ # 测试代码
│ ├── test_module1.py # 模块1测试
│ └── test_module2.py # 模块2测试
├── docs/ # 文档
│ ├── getting_started.md # 获取 started.md
│ └── contribution.md # 贡献指南
└── .gitignore # git忽略文件文件职责定义
- main.py: 主程序入口,负责初始化和启动程序。
utils/: 存放工具函数,包括辅助函数和配置文件。
- helper.py: 提供各种辅助功能,如日志记录、错误处理等。
- config.py: 存放程序配置信息。
modules/: 存放程序的主要功能模块。
- module1.py: 模块1的具体实现。
- module2.py: 模块2的具体实现。
tests/: 存放测试代码,确保每个模块的功能正确性。
- test_module1.py: 对模块1进行测试。
- test_module2.py: 对模块2进行测试。
docs/: 存放项目文档。
- getting_started.md: 提供项目的入门指南。
- contribution.md: 指导如何为项目贡献代码。
- .gitignore: 定义git需要忽略的文件和目录。
执行纪律
- 代码审查: 所有代码提交前必须经过至少一名其他成员的审查。
- 测试: 每个功能模块完成后必须编写相应的测试用例,并通过所有测试。
- 文档更新: 任何代码变更后必须同步更新相关文档。
- 版本控制: 使用git进行版本控制,遵循git flow工作流。
施工说明书.md
将以上内容保存为施工说明书.md文件。
todolist.md
创建一个todolist.md文件,用于记录每一步的完成情况。
# Todo List
- [ ] 初始化项目结构
- [ ] 编写主程序入口
- [ ] 实现工具函数
- [ ] 实现主要功能模块
- [ ] 编写测试用例
- [ ] 编写项目文档
- [ ] 提交代码审查
- [ ] 推送到远程仓库每完成一步,更新todolist.md文件中的对应条目为已完成状态。
评论已关闭