Remy の使い方

コード変更をレビューする

レビュー範囲を設定し、各指摘を確認します。

対象範囲: デスクトップアプリのローカル Git プロジェクトです。

コミット前に、変更が要件を満たし、新たな問題を生んでいないか Remy に確認を依頼します。指摘を 1 件ずつ確認できます。この例では、まずレビューを行い、その後で変更するかを判断します。

1. プロジェクトとレビュー範囲を準備する

デスクトップガイドに従ってプロジェクトを追加し、その中で新しいチャットを開始します。

タスクを送信する前に、次を準備します。

  • 変更で対処すべき要件や問題。
  • 現在の未コミットの変更全体や、指定したファイル群など、レビューする範囲。
  • 維持すべき動作と完了基準。

Changes は現在の作業ツリーを表示し、以前の作業を含む場合があります。 先にファイル一覧を確認してください。一部だけをレビューしたい場合は、プロンプトで範囲を指定してください。

2. レビューを開始する

例の要件を、プロジェクトの実際のタスクに置き換えてください。

プロンプトの例
このプロジェクトの注文一覧のフィルタリングに関する未コミットの変更をレビューしてください。

要件は、キーワードまたはステータスのフィルターを変更すると、一覧が 1 ページ目に戻り、結果を更新し、既存の並べ替え順を維持することです。

まずレビューするファイルを一覧にし、ステージ済みの変更、未ステージの変更、新規ファイルを区別してください。
この要件に関する変更だけをレビューし、無関係の既存作業は対象外にしてください。

特に次を確認してください。
1. 実装が要件を満たしているか。
2. リクエストパラメーター、状態の更新、表示結果が一貫しているか。
3. 結果が空の場合、フィルターを素早く連続変更した場合、リクエストが失敗した場合の問題。
4. テストが実際の変更を網羅しているか、重要なケースが不足していないか。

重要度順に指摘を挙げてください。各指摘には、ファイル内の場所、発生条件、実際の影響、裏付けとなる証拠、推奨事項を含めてください。
確認済みの問題と、まだ検証が必要な問題を分けてください。問題が見つからない場合は、レビュー範囲と対象外の項目を説明してください。

レビューだけを行ってください。ファイルの編集、依存関係のインストール、コミット、プッシュは行わないでください。

3. 指摘を確認する

関連ファイルを開き、各指摘が妥当か確認します。

確認項目 答えられるようにすべきこと
レビュー範囲 依頼した変更を対象にし、新規ファイルを含め、無関係の作業を除外したか?
証拠 その場所は存在し、説明は現在の実装と一致するか?
発生条件 どの条件で問題が起きるか?再現やテストによる確認ができるか?
影響 動作に影響する問題か、それとも別途検討すべき改善か?
チェック 実際に実行したもの、提案しただけのもの、実行できなかったものはどれか?

指摘が曖昧な場合は、詳細を依頼します。

プロンプトの例
指摘 2 を詳しく説明してください。正確なコードと発生条件を特定し、最小限の再現手順を示してください。
まだ仮説であればそう明記し、検証に必要なチェックを挙げてください。
まだファイルは編集しないでください。

4. 選択した問題を修正する

必要な変更を確認したら、同じチャットで続けます。

プロンプトの例
確認済みの指摘 1 だけを修正してください。
ほかの既存の変更を維持し、プロジェクトの現在の方針に従い、関連するテストを追加して実行してください。
変更したファイル、チェック結果、完了できなかったチェックをまとめてください。
まだコードのコミットやプッシュは行わないでください。

実際の差分を再度確認し、元の再現手順で動作を確認します。Verification があるバージョンでは、要件に照らして結果を確認するよう明示的に依頼できます。その結論にも、実際の変更とチェック結果の裏付けが必要です。

5. 完了の目安

範囲が明確で、根拠をたどれる指摘があるレビューを得られます。修正すべき問題、検証すべき仮説、未確認の範囲を区別できます。修正も依頼した場合は、対応する変更とチェック結果を確認できます。

「問題が見つからない」は、すべての状況を検証したという意味ではありません。コミットやマージの判断は、プロジェクトの通常の手順に従ってください。

6. 関連ガイド