request-refactor-plan について
リファクタリングの依頼を、検討済みの詳細な計画と GitHub issue にまとめるスキルです。要件の確認、範囲の定義、テスト方針、小さなコミットへの分割を進めます。
主な機能
- 01現在のコードベースの調査
- 02代替案と実装詳細の検討
- 03範囲とテスト方針の明確化
- 04動作を保つ小さなコミットの計画
- 05構成に沿った GitHub issue の作成
活用シーン
- 01リファクタリング提案の準備
- 02範囲とテスト方針の合意
- 03変更を段階的なコミットに分割
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/インストール後、Claude Code で/request-refactor-planを入力して読み込まれたか確認します。
同梱ファイルagents/openai.yaml
詳細
このスキルは、ユーザーがリファクタリングの依頼を作成したいときに呼び出されます。以下の手順に沿って進めてください。必要ないと判断した手順は省略してもかまいません。
-
解決したい問題について、考えられる解決策のアイデアも含めて、詳しく説明してもらいます。
-
リポジトリを調べ、ユーザーの説明を検証し、コードベースの現在の状態を把握します。
-
ほかの選択肢を検討したかどうかを尋ね、別の選択肢を提示します。
-
実装についてユーザーにヒアリングします。非常に詳細かつ徹底的に確認してください。
-
実装の正確な範囲を詰めます。変更する内容と変更しない内容を明確にします。
-
コードベースを確認し、この領域のテストカバレッジを調べます。テストカバレッジが不十分な場合は、テスト計画についてユーザーに尋ねます。
-
実装を小さなコミットに分割した計画を作成します。Martin Fowler の助言「リファクタリングの各ステップをできるだけ小さくし、常にプログラムが動作していることを確認できるようにする」を忘れないでください。
-
リファクタリング計画を記載した GitHub issue を作成します。issue の説明には次のテンプレートを使用してください。
問題の説明
開発者の視点から見た、開発者が直面している問題。
解決策
開発者の視点から見た、問題の解決策。
コミット
実装計画を詳細に記述します。平易な英語で、実装を可能な限り小さなコミットに分割してください。各コミット後もコードベースが動作する状態を保つ必要があります。
決定事項
決定した実装内容の一覧。以下を含めることができます。
- 作成または変更するモジュール
- 変更するモジュールのインターフェース
- 開発者から得た技術的な明確化事項
- アーキテクチャ上の決定
- スキーマの変更
- API コントラクト
- 具体的な相互作用
具体的なファイルパスやコードスニペットは含めないでください。すぐに古くなる可能性があります。
テストに関する決定事項
決定したテスト内容の一覧。以下を含めてください。
- 優れたテストの説明（実装の詳細ではなく、外部動作のみをテストする）
- テスト対象のモジュール
- テストの参考事例（コードベース内にある、同種のテストなど）
対象範囲外
このリファクタリングの対象範囲外となる内容の説明。
追加メモ（任意）
リファクタリングに関する追加メモ。