mcpField

pr-hygiene

github.com/icodecraftテスト・品質2747 回インストール14 週間前に更新
リポジトリ

pr-hygiene について

pr-hygieneは、レビューしやすいPull Requestを準備するためのスキルです。変更範囲やステージ済みファイルを確認し、説明文やリスクの整理を支援します。

主な機能

  1. 01変更範囲とステージ済みファイルの確認
  2. 02PR説明テンプレートの利用
  3. 03具体的な命令形タイトルの作成
  4. 04レビュー時の懸念点の提示
  5. 05リスクの高いPR慣行の回避

活用シーン

  1. 01PR作成前のブランチ確認
  2. 02概要とテスト計画の作成
  3. 03動作変更と残存リスクの説明

インストール

コマンドをコピーしてターミナルで実行します。

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

インストール後、Claude Code で/pr-hygieneを入力して読み込まれたか確認します。

詳細

PR 衛生

現在の作業を、人間が一度でレビューできる PR に変換します。

公開する前に

  • ブランチには1 つの論理的な変更が含まれている (または明確にラベル付けされたスタックコミット)
  • 自分が追加した console.log、debugger、TODO: temp、コメントアウトされたブロックが残っていない
  • 無関係なフォーマットのみの変更が混ざっていない
  • シークレット、.env、ローカルのみのファイルがステージされていない
  • 差分が宣言した目的と一致している —「余計なお世話」がない

説明文のテンプレート

この構造を使用します (セクション名はホストに合わせて調整してください: 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 利用者にとって変化した動作
  • 自分が確信を持てていないこと

アンチパターン

  • 必須でない限り、リファクタリング + 機能追加 + 依存関係の更新を 1 つの PR に絶対に混ぜない
  • 警告なしに共有ブランチを絶対に force-push しない
  • 「テストは後で」という計画もないまま絶対に PR を公開しない
  • 破壊的変更を説明文の途中に絶対に埋もれさせない

PR を公開するよう依頼された場合

  1. まず自分の言葉で差分を要約する
  2. テンプレートを使ってタイトル + 本文の下書きを作成する
  3. 残存するリスクを短い 1 つのセクションに列挙する

コメント

Markdown 対応