CodeRabbitを知ったきっかけ
アドカレのページで面白そうなプレゼント企画があったので「使ってみようかな」
となったのがきっかけです。
なんでこの記事を作ったのか？
もちろん、自分でもCodeRabbitは試してみたんですが、
ちょっと僕にはむずかしかったんですよね...
初めて使った時はこんな感じだった
「わ！なんかPRにコメントついてる！」
「これなんなんや...」
「レビューっぽいことしてくれへんぞ」
「どゆこと？？？」
挙句のはてにCodeRabbitを無効化してしまいました。
理由は明確で、僕がドキュメントをちゃんと読まなかったことなんですよね。
日本語で書かれてなかったので自動翻訳してみましたが意味がわからず断念。
英語のドキュメントを読むのが苦手な人でもCodeRabbitに慣れてほしいな〜
僕みたいな目にあって欲しくないな〜
という気持ちで書いてみました。
使い方
ログイン
重要: レビューしたいポジトリのあるサービスの
アカウントでログインすること！
例えば、GitHubのリポジトリをレビューしたかったら
GitHubでログインするということです！
GitHub, GitLab, AzureDevOps, Bitbucketのアカウントを使えるみたいです。
Pull Request内で会話できる
Code Rabbitの特徴の一つが、「Pull Request内でAIと直接会話できること」です。
レビューの仕方について質問したり、状況を説明したり、フィードバックを送信したり
することが、既存のシステムに統合されてとても便利です！
試しにプルリクエストを作ろう！
僕は以前公開したa-teapot-not-a-coffee-machineに
牛乳を追加するというPRを出しました。
(どういうリポジトリなのかは記事をチェック！)
すると...
なんかきました！
訳してみました
設計
新しい飲み物"milk"とその絵文字"🥛"をapp.pyの
DRINKS辞書内に追加しました。既に存在していた"tapioca"には末尾にコンマが追加されました。APIやロジック、制御フローは変更されていません。変更点
対象 / ファイル 要点
DRINKS辞書の更新
app.py"milk": "🥛"をDRINKS辞書に追加、"tapioca"の末尾にコンマを追加コードレビューにかかる推定時間
🎯 1 (小さい) | ⏱️ ~２分未満
ポエム
ミルクがお祝いムード満点の仲間入り。
カップに入ったタピオカが、まさに本物。
ドリンクメニューには絵文字が躍る。
シンプルな一言が、一日を明るく彩ります！🥛✨マージ前のチェックと仕上げ
✅ 完了したチェック (3件)
チェック名 状態説明
説明のチェック ✅ 完了 チェックはスキップされました - CodeRabbitの高レベルな要点説明が有効です。
タイトルのチェック ✅ 完了 プルリクエストのタイトル'Add milk to drinks list'は「'milk'をDRINKS辞書に絵文字'🥛'で追加する。」という主要な変更点を要約しています
Docstringの検証 ✅ 完了 変更されたファイルに実行できるDocstringの検証が見つかりませんでした。
✨ 仕上げ
- 📝 Docstringの生成
🧪 テストの生成 (ベータ)
- テストと一緒にPRを作成
- コピー可能なテストをコメントに公開
add-milk-to-drinksにテストをコミット📜 最近のレビューの詳細
使用された設定: デフォルトレビュープロファイル: CHILL
プラン: Pro
📥 コミット一覧
PR のベースから変更されたファイルと、cdb6449 と 761be9e の間で変更されたファイルを確認します。📒 処理対象として選択されたファイル (1)
app.py(1 ハンク)🔇 追加情報 (1)
app.py (1)>
10-11: LGTM! ミルクドリンクオプションのすっきりとした追加。新しいエントリは既存のパターンに完全に従っており、10行目の末尾のカンマは Python のベストプラクティスであり、今後の追加をよりすっきりとさせます。
@coderabbitai helpをコメントすると、使用可能なコマンドのリストと使用方法のヒントが表示されます。
所々機械翻訳が混じってるので注意を
ファイルの変更内容の要約はもちろん、仕上げもやってくれるみたいです。
自分の書いたPR内容が不十分な場合は、CodeRabbitに頼るのも手な気がします。
追記: 日本語でもレビューできる
リポジトリに.coderabbit.yamlを配置して
language: "ja"
と書くか、ダッシュボードの
Organization Settings > Configuration > General > Review Language
で日本語を指定すればレビュー時の言語を日本語に変更できるそうです。
@goofmintさん、コメントで教えていただきありがとうございます。
感想
AIが全てのレビューをやると不安だな〜という人も、CodeRabbitを
「コードレビューの手助け」のように使えると思いました。
さらに、ほとんどの操作がPR内で完結し、複数のツールを行き来する
手間も減ると思いました。皆さんも試してみてください！