improve

改善

動作を変えずに、コードを理解しやすくします。読者がたどる必要のある層と、覚えておかなければならない隠れた状態を減らします。

手順

1. リクエスト、現在の差分、または最近変更されたコードから対象を特定します。
2. 対象、そのテスト、関連する周辺コードを読みます。変更してはならない動作を明示します。
3. その動作を検証するテストがない場合は、対象を絞ったテストを追加し、変更前のコードで実行します。テストのみの変更が通過したら、リファクタリングの前にコミットします。自動テストで動作を検証できない場合は、その理由を説明し、別の根拠を示します。
4. 不要な複雑さ、重複、デッドコード、わかりにくい名前、不自然な境界、役に立つ以上にコストのかかる抽象化を見つけます。重要な値ごとに、新しい読者が「どこから来て、何によって変わるのか」を説明できるか確認します。
5. まず削除します。残ったコードを組み替える前に、デッドコードと冗長なチェックを取り除きます。その後、重複の排除、名前の変更、簡素化、抽出、インライン化によって、対象を絞った改善を行います。
6. ユーザーから明示的な変更依頼がない限り、公開インターフェース、データ構造、エラー、ユーザーから見える動作を維持します。
7. リファクタリングによって影響を受ける動作を対象としたテストとチェックを実行します。何が改善され、どの動作が維持され、その根拠は何かを報告します。

出力

何が簡素化されたか、どの動作が変わらなかったか、それを裏付けるチェックを明記します。未検証のまま残っている動作があれば、それも明記します。

制約

• 製品の対象範囲を広げたり、無関係なクリーンアップを取り込んだりしないでください。
• 広範囲な書き換えより、わかりやすい変更を少数行うことを優先してください。
• 再設計のほうが簡単な場合でも、動作を維持してください。