贡献验证#

除代码本身外,贡献通常还需要额外的变更。为确保所有贡献被正确集成,我们遵循一系列验证步骤。


⚙️ 自动验证#

每当有拉取请求被创建或用新提交更新时,我们会使用自动化脚本来验证贡献。这些脚本检查:

  • 元数据是否已定义且为最新(参见元数据页面

  • 代码是否通过所有单元测试,确保无回归问题(参见调试页面

Bookshelf 贡献者也可在本地通过以下命令手动执行这些检查:

uv run check
uv run modules test

📄 拉取请求模板#

创建拉取请求时,贡献者会收到检查清单模板,确保关键步骤不被遗漏。该清单涵盖无法自动验证的变更,例如:

  • 更新变更日志,包含贡献详情及拉取请求ID

  • 添加或更新新功能/现有功能的文档

  • 在适用场景包含单元测试

  • 将拉取请求关联至现有问题

该清单确保贡献在提交前符合项目标准。


🔎 人工评审#

自动化检查后,其他 Bookshelf 贡献者会对拉取请求进行人工评审,该评审确保:

  • 代码质量及其与项目标准的符合度

  • 充分的文档和测试覆盖

  • 遵守整体贡献指南要求

评审流程完成后,贡献将被批准并合并。