重构与文档维护
保持行为一致
重构侧重改善代码组织,应明确是否允许改变对外行为。依赖升级、接口调整和数据迁移可能影响现有使用方,不宜混入“整理代码”的笼统任务中。

分步实施后,应持续运行相关检查。若确需改变行为,应将其作为新的功能变更单独说明,而非继续归入“行为不变”的重构。
更新项目说明
代码变更后,应同步检查 README、配置示例和接口文档。文档中的命令、目录和字段应以当前项目为依据,不应根据常见项目结构自行补写。
重构侧重改善代码组织,应明确是否允许改变对外行为。依赖升级、接口调整和数据迁移可能影响现有使用方,不宜混入“整理代码”的笼统任务中。

分步实施后,应持续运行相关检查。若确需改变行为,应将其作为新的功能变更单独说明,而非继续归入“行为不变”的重构。
代码变更后,应同步检查 README、配置示例和接口文档。文档中的命令、目录和字段应以当前项目为依据,不应根据常见项目结构自行补写。
评论
登录后查看