検証できる指摘でコードをレビューする方法。
コードレビューでは指摘を具体的な動作やリスクに結び付けます。プロジェクト規約がないのにスタイルの好みを不具合と扱わないでください。
作業手順をタスクに合わせましょう。
期待する動作と規約に照らしてコードを確認し、指摘を具体的な行やケースに結び付けます。不具合、意味のあるリスク、任意のスタイル提案を区別し、可能なら再現例を示してください。
- 用意するもの
- コード差分とプロジェクトの規約。
- 得られるもの
- 参照箇所を伴う潜在的な不具合と保守性の指摘。
入力と結果を確認しましょう。
説明用の入力と出力 · 実際の WebAct 実行ではない学習用サンプル
入力項目サンプル個
Python code review: def average(total, count): return total / count. No zero-count contract supplied.
完成例
Finding: count=0 raises ZeroDivisionError. Reproduction: average(10, 0). Contract question: should an empty set return a designated value or raise a deliberate domain error? Proposed action: define that behavior and add a zero-count test before changing the implementation. Ordinary nonzero division is not itself identified as a defect.
この入力をプロンプトに読み込み、WebAct にコピーして試してください。結果は掲載例と異なる場合があります。
判断のポイントとトラブル対処。
スタイルの好みをバグとして報告すべきですか？
プロジェクトの規約に沿って分類します。好みは、要件を満たさない動作とは異なります。
呼び出し側が防いでいる問題をレビューが指摘するのはなぜですか？
関数の契約と呼び出し箇所を調べてください。文脈がない断片として評価せず、前提を明示します。
自分の資料で試しましょう。
タスクのプロンプト内の例を自分の資料に置き換えてください。必要な要件を残し、タスクを WebAct にコピーします。
タスクを調整してコピー ↑