merge-ready について
merge-readyは、メンテナーの最終レビューに向けてブランチを準備するコードレビュースキルです。origin/mainとの差分を確認して実際の問題を修正し、ローカルチェックを実行してPRを作成または更新しますが、マージは行いません。
主な機能
- 01遅れている場合にorigin/mainを取得してマージ
- 02コミット済み・未コミットの変更をレビュー
- 03セキュリティ、簡潔さ、課金悪用リスクを確認
- 04問題を修正して変更をコミット
- 05pnpm ci:checkとpnpm testを実行
- 06プルリクエストを作成または更新
活用シーン
- 01機能ブランチをメンテナーのレビュー用に準備
- 02変更に潜むセキュリティや課金リスクを確認
- 03プロジェクトのチェックを実行してPRを提出
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/インストール後、Claude Code で/merge-readyを入力して読み込まれたか確認します。
詳細
このブランチをメンテナーによる最終レビューに備えて整えてください。何かのビルドも依頼されている場合は、まずビルドしてください。
ブランチが遅れている場合は、origin/main を取得してマージしてください。次に、未コミットおよび未追跡のファイルも含め、ブランチ上のすべてを origin/main と比較してレビューしてください。すべての製品上の判断と機能変更を理解してください。
安全ですか？
できる限りシンプルですか？ ブランチの最終状態を踏まえて、削除または簡素化できるものはありませんか？ まれなエッジケースを理由に、過剰な作り込みをしていませんか？ 私たちはコードを削除することを優先します。
API や SDK（TanStack、DataForSEO、Autumn、Cloudflare）を慣例に沿って使っていますか？ すでに提供されている機能を再実装しているコード、存在しない制限への回避策、必要以上の費用がかかるコードがないか確認してください。何かおかしいと感じた場合に限り、ドキュメントを確認してください。
課金を大幅に悪用できる方法、たとえば料金を支払わずにクレジットや有料機能を得たり、プロバイダーへの呼び出しを行ったりする方法はありますか？ 誰もわざわざ悪用しないような小さな漏れは無視してください。
そのほかは、最適と思う方法でレビューしてください。間違っていた場合に最も大きな損害を招きうる箇所を見極め、そこに時間をかけてください。docs/maintainers/review-guidelines.md には、リポジトリの不変条件と、問題に見えても意図的なものが記載されています。
実際の問題を修正してください。作業しながらコミットしてください。ローカルで pnpm ci:check と pnpm test を成功させてから、プッシュしてください。これらのローカル実行を CI の代わりとするため、GitHub CI の完了を待つ必要はありません。
main を対象に PR を作成または更新してください。説明は simple-issue-description 形式で記述し、メンテナーの判断に委ねたものがあれば「Extra context」に記載してください。
決してマージしないでください。最後にレビューするのはメンテナーです。