Hands-on Guide

コード レビューを体験する

最初のプル リクエストを作成して、CodeRabbit の自動コード レビューを確認します。

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

CodeRabbit がリポジトリに連携されました。次は実際に動作を確認しましょう。意図的に不完全なコードを含むプル リクエストを作成して、CodeRabbit がどのように問題を検出し、実践的なフィードバックを提供するかを体験します。

プル リクエストを作成する

coderabbit-test リポジトリで、以下の手順を通常の Git ワークフローで実施してください。

1

ブランチを作成する

add-utils という名前のブランチを作成します。

2

新しいファイルを作成する

add-utils ブランチに、以下の内容で simple_utils.py を作成します。

# simple_utils.py - A tiny utility library

def reverse_string(text):
    """Reverses the characters in a string."""
    return text[::-1]

def count_words(sentence):
    return len(sentence.split())

def celsius_to_fahrenheit(celsius):
    return (celsius * 9/5) + 32
3

ファイルをコミットする

任意のコミットメッセージで add-utils ブランチにファイルをコミットします。

4

プル リクエストを作成する

add-utils ブランチを main ブランチへマージするプル リクエストを作成します。プル リクエストのメッセージは任意の内容で構いません。

CodeRabbit の反応を確認する

しばらくすると、CodeRabbit が @coderabbitai GitHub アカウントでプル リクエストに応答します。GitHub のプル リクエスト ページで以下の動作が確認できます。

  • プル リクエストのサマリーを未記入の場合、CodeRabbit が新しいサマリーを追加します。
  • プル リクエストの内容の分析とコメントを投稿します。
  • 詳細なコード レビューを別のコメントとして添付します。

以下のようなレビューが表示されます。CodeRabbit のフィードバック例

ドキュメント文字列の欠如や入力値の検証不足など、CodeRabbit が Python ライブラリの問題点を指摘し、改善方法を提案します。

CodeRabbit の指摘に対して、次のステップで AI とチャットし、より詳しく掘り下げることができます。