跳到主要内容

代码修改边界

贡献时优先做和目标直接相关的最小改动。

通常可以接受的顺手修改有:

  • 当前改动直接涉及的位置上的命名修正
  • 明显错误的注释、文档和示例修正
  • 同一位置的小范围重复代码整理
  • 与本次改动直接相关的低风险清理

通常不应混进同一改动的内容有:

  • 无关模块的大范围重构
  • 整个子系统的风格统一
  • 与当前问题无关的性能优化
  • 把历史代码整体翻写成另一套结构

驱动与并发相关改动必须尤其谨慎,包括中断路径、DMA 路径、ReadPort / WritePort / OperationTopic / LinuxSharedTopicSemaphore / Thread / ASync。对这类改动,说明里至少要写清楚改了哪条路径、改变了什么语义,以及如何验证没有引入回归。

性能类改动不要只给“感觉更快”的结论。至少说明测的是哪条路径、对比的是哪一版行为、是否有功能或稳定性权衡。

文档重写也应控制范围。同目录页面结构保持一致,不把使用教程写进贡献指南,也不把验证过程、评审过程和试错过程写进正文。