このスキルは、ユーザーがリファクタリングリクエストを作成したいときに呼び出されます。以下の手順に従ってください。必要ないと判断したステップはスキップしても構いません。
-
ユーザーに、解決したい問題の長く詳細な説明と、解決策に関する潜在的なアイデアを尋ねてください。
-
リポジトリを調査して、ユーザーの主張を検証し、コードベースの現在の状態を理解してください。
-
ユーザーが他の選択肢を検討したかどうかを尋ね、他の選択肢を提示してください。
-
実装についてユーザーにインタビューしてください。非常に詳細かつ徹底的に行ってください。
-
実装の正確な範囲を決定してください。変更する予定のものと、変更しない予定のものを明確にしてください。
-
コードベースを調べて、この領域のテストカバレッジを確認してください。テストカバレッジが不十分な場合は、ユーザーにテスト計画について尋ねてください。
-
実装を小さなコミットの計画に分割してください。Martin Fowlerの「各リファクタリングステップは可能な限り小さくし、常にプログラムが動作していることを確認できるようにする」というアドバイスを覚えておいてください。
-
リファクタリング計画をGitHub Issueとして作成してください。Issueの説明には、以下のテンプレートを使用してください。
問題文
開発者が直面している問題を、開発者の視点から記述します。
解決策
問題の解決策を、開発者の視点から記述します。
コミット
詳細な実装計画。プレーンな英語で計画を記述し、実装を可能な限り小さなコミットに分割してください。各コミットはコードベースを動作可能な状態に保つ必要があります。
決定事項
行われた実装上の決定のリスト。以下を含めることができます:
- 構築/変更されるモジュール
- 変更されるモジュールのインターフェース
- 開発者からの技術的な明確化
- アーキテクチャ上の決定
- スキーマの変更
- API契約
- 特定の相互作用
特定のファイルパスやコードスニペットは含めないでください。すぐに古くなる可能性があります。
テスト方針
行われたテスト上の決定のリスト。以下を含めてください:
- 良いテストの条件の説明(実装の詳細ではなく、外部の振る舞いのみをテストする)
- テストされるモジュール
- テストの先行事例(コードベース内の同様のタイプのテスト)
対象外
このリファクタリングの対象外となる事項の説明。
その他のメモ(オプション)
リファクタリングに関するその他のメモ。