cleanup-changes

変更の整理スキル

人間もエージェントも通常、コードを書く際に試行錯誤を繰り返し、最終的な目標を達成するために、必須ではない変更や不要な変更も数多く加えます。しかし、この試行錯誤の過程で生じた必須ではない変更や不要な変更は、最終的なコードに含めるべきではありません。必要に応じて変更を見直し、不要な変更を元に戻して、本質的な変更だけに集中してください。

適用するタイミング

ユーザーから変更の整理を依頼されたとき、またはコミットやプルリクエストを作成する前に、このスキルを実行してください。

手順

以下はこのスキルの基本的な手順です。指定された手順に従ってください。ユーザーから明示的に指示されていない限り、Git のステージング状態を変更しないでください。ユーザーは、コードの最後に期待していた状態をスナップショットとして、変更をステージングしている場合があります。

1. 試行錯誤の過程を振り返る

タスクの試行錯誤の過程を振り返り、本質的に必要だった変更と、試したものの最終的には効果がなく不要だった変更を区別してください。

ある変更が本質的に必要かどうかを、決めつけないでください。たとえば、バグを修正する場合、バグが最終的に修正されたときの変更を見直し、バグの本質的な原因と根本原因を把握したうえで、それに基づいて各変更が本質的に必要かどうかを判断してください。

各変更が必要かどうかを判断する際は、複数の要因によって発生するバグに特に注意してください。バグの原因は、単一の単純なものの場合もあれば、複数の要因の場合もあります。単一の単純な原因であれば、バグが修正されたときの最後の変更だけで十分な場合があり、それ以前の変更は不要かもしれません。複数の要因によるバグの場合は、最後の変更だけでは不十分で、そこに至る試行錯誤の過程で加えた変更の一部も必要な場合があります。バグの根本原因が単一か複数かも含めて慎重に検討し、どの変更が必要で、どの変更が不要かを判断してください。

2. 不要な変更を元に戻す

前の手順で不要だと判断した変更を元に戻し、本質的な変更だけを残してください。

ただし、変更そのものに厳密には必要でない場合でも、現在の変更に関連する誤字の軽微な修正や小規模なリファクタリングは許容されます。一般に、コーディングでは、変更箇所周辺で見つかった誤字の修正や、現在の変更に関連する小規模なリファクタリングは、厳密には必要でなくても許容されます。