mcpField

pr-hygiene

github.com/icodecraft测试与质量2747 次安装14 周前更新
代码仓库

关于 pr-hygiene

pr-hygiene 是用于整理可审查 Pull Request 的技能，面向提交代码变更的开发者。它涵盖变更范围、暂存文件、描述结构和审查者关注点。

主要功能

  1. 01检查变更范围与暂存文件
  2. 02使用 PR 描述模板
  3. 03编写具体的祈使式标题
  4. 04说明审查者关注点
  5. 05避免高风险 PR 做法

适用场景

  1. 01开 PR 前检查分支
  2. 02起草摘要与测试计划
  3. 03说明行为变更和剩余风险

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/icodecraft/anti-slop --skill pr-hygiene

安装后在 Claude Code 中输入/pr-hygiene确认已加载。

详细介绍

PR 卫生

把当前工作整理成一个人类能一次过审的 PR。

开启前

  • 分支包含一个逻辑变更（或清晰标注的堆叠提交）
  • 没有遗留的 console.log、debugger、TODO: temp、你添加的注释掉的代码块
  • 没有无关的仅格式变动
  • 密钥、.env 和仅本地文件未被暂存
  • Diff 与声明的目标一致 —— 没有“额外帮忙”

描述模板

使用此结构（根据宿主调整章节名称：GitHub/GitLab）：

## Summary
<1–3 bullets: what and why>

## Test plan
- [ ] <how you verified>
- [ ] <edge case worth checking>

## Notes
<risks, follow-ups, screenshots if UI>

提交 / PR 标题

  • 祈使句、具体：fix checkout: reject expired discount codes
  • 不要：update stuff、fix、WIP、address comments

评审者共情

指出：

  • 看起来吓人但机械性的文件（重命名、生成的）
  • 对调用方/API 消费者发生变化的行为
  • 任何你不确定的地方

反模式

  • 除非必需，绝不在一个 PR 中混合重构 + 功能 + 依赖升级
  • 未经警告绝不强制推送共享分支
  • 绝不打开带有“测试待定”且没有计划的 PR
  • 绝不把破坏性变更埋在描述中间

如果被要求开启 PR

  1. 先用自己的话总结 diff
  2. 用模板起草标题 + 正文
  3. 在一个简短章节中列出剩余风险

评论

支持 Markdown