提交 PR
PR 建议保持聚焦、可验收。
简单清单
- 描述用户影响与风险边界
- 给出可执行的验证方式(命令或 UI 路径)
- 避免把无关重构混在一起
推荐结构(让评审更省力)
- 背景/问题:一句话说明要解决什么。
- 改动点:列出关键文件/模块与行为变化。
- 验收方式:给出最短可验证命令(例如
hugo --gc --minify ...、或某条 CLI 命令的输出期望)。 - 回滚策略:如果上线后出现问题,如何快速撤回/降级。
文档变更的特殊注意
- 入口页要能“聚合 + 分流”:让读者知道自己应该从哪里开始、下一步去哪。
- 避免未来日期(会影响 Hugo 渲染)。
- URL 稳定优先:需要迁移就用
aliases吸收旧路径。
如果改动会影响用户行为,记得同步更新入口文档,让用户能按最短路径跑通。