code-review-burntsushi

code-review-burntsushi

「このコードが、うたっているとおりに動作すると合理的に期待できますか？」 — BurntSushi

コードレビューでは、このコードが不変条件、失敗モード、コスト、セマンティクスについて正直かどうかを確認します。単に動作するかどうかだけではありません。

クイックスタート

差分またはファイルを貼り付け、「burntsushi review」または「honest review」と伝えます。REFERENCE.md にある10個の一般的な観点を確認し、コードが Rust の場合は Rust 固有の2つの観点も確認してから、指摘事項を出力します。

手順

1. 変更内容を述べる — このパッチで何をしているのか、1文で説明します。不明な場合は、まず質問します。
2. REFERENCE.md にある10個の一般的な観点を順にすべて確認します。指摘事項のある観点はすべて報告します。
3. Rust の場合： Rust 固有の2つの観点（エンコーディングの不変条件、所有権／割り当て）も確認します。
4. 以下の出力形式に従って、指摘事項を最初に出力します。

出力形式

• 指摘事項を深刻度の高い順に先頭に記載します。Must fix、次に Consider、次に Open questions の順にし、空のセクションは省略します。
• 指摘事項には [Axis N | file:line] を付けます。
• 各指摘事項では、不変条件、コスト、または失敗モードを挙げ、具体的な代替案を1つ示します。
• 指摘事項の後に簡潔な Summary を追加します。ユーザーから求められない限り、称賛は追加しません。

トーンのルール

• 不変条件、失敗モード、または隠れたコストを正確に指摘します。
• 指摘事項ごとに、実用的な代替案を1つ提案します。
• 正しさやコストが不明瞭になる場合を除き、スタイル、命名、書式について細かく指摘しません。
• 静的なプログラマー不変条件に対する unwrap／アサーションは問題にしません。失敗の原因がランタイム、ユーザー、または環境にある場合に限り、パニックを指摘します。

リファレンス

• REFERENCE.md — すべての観点、例、モデルのコメント、スキルのルール