重构指南

背景​

自 2014 年 2 月 12 日编写了第一行代码以来，Gitea 已经发展成為一个庞大的项目。 因此，代码库变得越来越大。代码库越大，维护就越困难。 存在许多過时的機制，许多框架混合在一起，一些遗留代码可能会导致错误並阻碍新功能的开发。 為了使代码库更易于维护，使 Gitea 变得更好，开发人员應牢记使用現代機制来重构旧代码。

本文檔是关于重构代码库的指南集合。

重构建议​

• 设计更多关于未来的内容，而不僅僅解决当前问题。
• 减少模糊性，减少冲突，提高可维护性。
• 描述重构，例如：
  • 為什么需要重构。
  • 如何解决旧问题。
  • 重构的优点/缺点是什么。
• 只做必要的更改，尽量保留旧逻辑。
• 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个 PR 中完成。
• 如果存在分歧，應該請 TOC（技术监督委员会）参与决策。
• 添加必要的测试以确保重构的正确性。
• 非错误重构优先在里程碑的开始时進行，这样可以更容易地在發佈之前发現问题。

审查和合並建议​

• 重构的 PR 不應該长时间保持打开状态（通常為 7 天），應尽快進行审查。
• 重构的 PR 應尽快合並，不應被其他 PR 阻塞。
• 如果 TOC 没有异议，重构的 PR 可以在 7 天后由一名核心成员（非作者）批准后合並。
• 如果最终结果良好，容忍一些不完美/临时的步骤。
• 如果重构是必要的，容忍一些回归错误，並尽快修复错误。