跳到主要内容

审核清单

维护者审核 Pull Request 时,可以按下面清单检查。

内容

  • 标题是否准确。
  • 描述是否说明了读者能完成什么。
  • 步骤是否可以复现。
  • 是否写清楚准备工作。
  • 是否包含验证结果。
  • 是否有常见问题或排错说明。

格式

  • front matter 是否完整。
  • 标题层级是否从 ### 正常递进。
  • 代码块是否标注语言。
  • 图片 alt 文本是否清楚。
  • 内部链接是否有效。

截图

  • 截图是否必要。
  • 是否压缩到合理大小。
  • 是否泄露隐私或密钥。
  • 文件名是否按顺序命名。

发布

合并前确认:

npm run build

构建通过后再合并。