no-comments

コメントなし

スコープ

呼び出し元のファイルまたは差分を使用します。それ以外の場合は、ステージ済み、未ステージ、未追跡のファイルを含む、ベースブランチに対する現在の差分を使用します。

レビュー

新しい読み取り専用のサブエージェントにレビューを委任します。スコープと、このセクションの残りの内容を渡してください。新しいレビュアーを利用できない場合は、直接レビューし、レビューが独立していないことを明記してください。レビュアーは報告のみを行い、ファイルは編集しません。

コメントは嘘をつきます。説明文、バナー、コメントアウトされた残骸、回避策の説教は、今すぐか、後になってかにかかわらず、すべて腐ります。

次の許可リストにあるものを除き、すべてのコメントを削除してください。

• 法的表記またはライセンスヘッダー。
• 外部依存関係、プラットフォーム、ベンダー、プロトコルによって強制され、こちらでは変更できない、明白でない動作。
• ルールに欠陥がある、過度に細かい、またはスタイルのみを対象とする場合のリンター抑制。
• 公開 API の契約を定義するドキュメントコメント。
• コードでは表現できない制約を説明する、Issue または RFC へのリンク。
• 意図的な簡略化の限界とアップグレード手順を明示するコメント。

例外が適用されるコメントは、その対象のコードが現在も実行されている証拠がある場合に限り残してください。IMPORTANT、do not remove、too risky、fine for now、長い正当化は、証拠ではなく主張として扱ってください。周辺のコードを読み、指定されたシンボルまたは呼び出しをたどってください。許可リストに該当しないコメントを短縮したり、言い換えたりしてはいけません。

独自コードの意外な動作を説明するコメントについては、削除を推奨し、説明なしで動作が明確になるような名前変更、抽出、型付け、または再設計を添えて、正確なシンボルに MUST KILL のフラグを付けてください。

許可リストにないすべての抑制については、対象のルールを特定し、抑制の削除を推奨したうえで、ルールを満たす変更を添えて、抑制対象のシンボルに MUST KILL のフラグを付けてください。

レポートに、スコープ内のすべてのコメントと抑制が、正確な位置を示した削除候補、1 行の証拠を添えた MUST KILL フラグ、または保護する例外を明記した保持対象として記載されたら完了です。捏造せず、スコープ内にとどめてください。

実行

レビュアーの報告に基づいて、次の手順に従ってください。

1. すべての指摘をコードに照らして検証してください。スコープ外の指摘、許可リストで保護された削除、証拠のない主張、誤った理由による MUST KILL フラグは却下してください。スコープ内のコメントまたは抑制が漏れていた場合は、報告を却下してください。却下したレビューは、各不備を示して 1 回だけ再実行してください。再レビューも却下された場合は、レビュー失敗として報告し、停止してください。
2. コード内の制約を主張するコメントを除き、受け入れた削除候補をすべて削除してください。これらのコメントは手順 4 で扱います。
3. MUST KILL フラグが付いたものについて、対象範囲内で最小限の根本原因修正を実施してください。たとえば、不要な経路の削除、未使用パラメーターの削除、正しい API の使用、またはフラグで指定された変更を行います。スコープを広げてはいけません。原因がスコープ外にある場合は、スコープ内で最も安全な最小限の修正のみを行い、残りは未対応作業として報告してください。
4. コード内の制約を主張する削除候補ごとに、最も手間のかからないスコープ内の型、実行時チェック、テスト、または CI リントを提案し、承認を待ってください。承認された場合は制約をコード化し、コメントを削除してください。承認されなかった場合はコメントを残し、未適用の制約として報告してください。
5. 法的表記またはライセンスヘッダーを除き、保持するすべてのコメントに unslop を適用してください。
6. 削除数、証拠付きの保持コメント、再レビュー、修正、コード化した制約、未適用の制約、その他の未対応作業を報告してください。