Hands-on Guide

AI とチャットする

CodeRabbit との対話的な会話を通じて、レビュー内容をより深く理解します。

1 リポジトリ
2 コード レビュー
3 チャット
4 改善

CodeRabbit の最も強力な機能の一つは、コードについて自然な文脈を踏まえた会話ができることです。静的なフィードバックを受け取るだけでなく、フォローアップ質問、説明の要求、推奨事項への疑問提起、代替アプローチの検討などが可能です。この対話性によりコード レビューが協調的な対話へと変わり、「何を」変えるかだけでなく「なぜ」変えるかを理解できます。

CodeRabbit に質問してみる

CodeRabbit がプル リクエストをレビューした後、レビュー内容について対話できます。推奨事項に疑問を呈したり、説明を求めたり、プロジェクト固有のニーズに合わせてレビューアプローチを調整するよう依頼することもできます。

プル リクエストに以下の内容で新しい GitHub コメントを投稿してみましょう。

コメント例
@coderabbitai これらの関数に docstring は本当に必要ですか?名前からして役割は明白だと思うのですが。

しばらくすると、CodeRabbit が返信します。返信の内容は以下のようになります。

CodeRabbit の返信例

関数名だけで十分に理解できるという点はその通りです。特に小規模なプロジェクトで関数名が明確な場合、すべての関数に docstring が必須というわけではありません。

docstring には利点 (IDE のツールチップ、ドキュメント生成、将来の開発者への説明) がある一方で、非常に単純な関数には冗長に感じることもあります。最終的にはコーディング スタイルとプロジェクトの要件次第です。

このリポジトリでは明確なユーティリティ関数の docstring を省略することも合理的です。このリポジトリのドキュメントに関するレビューア プローチを調整しますか?

このケースでは、CodeRabbit はこのリポジトリの変更をレビューする際の振る舞いを、今後調整することを提案しています。ここではその提案には乗らず、次のステップに進んで、提案内容の一部を実装するよう CodeRabbit に指示してみましょう。

CodeRabbit と話せること

CodeRabbit は様々な種類のコードに関する会話ができます。

  • 推奨事項への質問 — 特定の変更が提案された理由を尋ねる
  • 代替案の検討 — 同じ問題に対する異なるアプローチを議論する
  • コンテキストの要求 — ベストプラクティスやデザイン パターンの説明を求める
  • 実装の詳細の確認 — 特定のコンテキストでの提案の適用方法を理解する
  • トレードオフの議論 — 異なるソリューションの長所と短所を検討する

プル リクエストのコメントで @coderabbitai を使うと、いつでも会話を始められます。CodeRabbit はプル リクエスト全体のコンテキストを把握しており、特定のファイル、関数、または以前のコメントを参照した回答が可能です。