RooLite Development向导

1. 核心理念:结构化、安全第一的开发流程#

  • 定义: RooLite 的开发流程不是自由随意的,而是遵循一个高度结构化、以安全为核心、由模板驱动的流程
  • 中心枢纽: 整个流程的核心是 GitHub Pull Request (PR),并且所有 PR 都必须使用一个非常详细的模板文件:.github/pull_request_template.md。这个模板是保证质量、文档和测试覆盖率的强制性工具

2. 严格的开发工作流与审查#

  • 标准流程: 开发者遵循 Fork -> Branch -> Implement -> Test -> Create PR 的标准流程。
  • 强制性 PR 模板: 提交的 PR 必须完整填写模板中的所有部分,包括:
  • 多阶段审查:

3. 清晰的架构边界和开发禁区#

  • 核心原则: 为了保证系统的稳定性和安全性,开发者不能随意修改核心配置文件
  • 只读 (READ-ONLY) 目录: 在开发工作流中,以下目录被视为禁区,绝对不允许在 PR 中被修改:
  • 扩展点 (Extension Points): 如果要添加新功能,必须在指定的扩展目录中进行,例如:

4. 全方位、强制性的测试要求#

  • 测试驱动: 测试不是可选项,而是代码提交的先决条件
  • 四层测试体系:
  • 手动验证: 除了自动化测试,开发者还必须进行手动测试,并记录在 PR 模板中。

5. 安全是开发过程不可分割的一部分#

  • 设计理念: 安全不是事后检查,而是贯穿于整个开发生命周期。
  • 关键实践:

总之,这份 “Development Guide” 描绘了一个成熟、严谨的开源项目管理范例。它强调贡献代码不仅仅是写功能,更是一种责任。通过强制性的模板、多阶段审查、严格的架构边界和全面的测试要求,RooLite 确保了项目在不断迭代和演进的过程中,始终保持高质量、高稳定性和高安全性。