pr-hygiene について
pr-hygieneは、レビューしやすいプルリクエストを準備するためのチェックリスト兼作成支援スキルです。ブランチの範囲やステージ済みファイルを確認し、構成の整った説明文と具体的なタイトルを作成します。
主な機能
- 01ブランチの範囲と変更の一貫性を確認
- 02デバッグ残骸や無関係な変更を確認
- 03ステージ済みファイルの秘密情報やローカルファイルを確認
- 04構成化されたPR説明文の下書き
- 05具体的な命令形のPRタイトル作成
- 06レビュー上の注意点と残るリスクの要約
活用シーン
- 01レビューしやすい変更の準備
- 02PRを開く前の差分確認
- 03GitHubまたはGitLabのPR説明文作成
- 04動作変更と残るリスクの記録
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ imrangadzhiev/ 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 つのセクションに列挙する
コメント
Markdown 対応