CodeRabbitはAIコードレビューサービスです。GitHubやGitLab、BitBucketなどと連携して、PRに対して自動的にAIコードレビューを提供します。AIコードレビューサービス専業として、数多くのオプションを用意しているのが特徴です。
そうしたオプションはダッシュボードか、 .coderabbit.yaml という設定ファイルで作成するのですが、YAMLファイルを一から作成するのは面倒です。そこで、今回はこの設定ファイルを手軽に作成する方法を紹介します。
1. ダッシュボードで作成する
まずひとつ目はダッシュボードで作成する方法です。これは、ダッシュボードでビジュアル的に設定を行った後で、ModeをYAML Editorにするという方法です。
そうすると、設定されている内容がYAML形式で表示されるので、これをコピーしてリポジトリ内に .coderabbit.yaml というファイルを作成して貼り付ければOKです。
なお、GUI ↔ YAML Editorは相互変換できるので、既存のYAMLに書かれている設定を貼り付けて、GUI上に設定反映も可能です。 .coderabbit.yaml を更新したい場合にも使える方法です。
2. コマンドを使う
PRの画面で @coderabbitai を呼び出すことで、設定ファイルを生成できます。使えるのは2種類のコマンドです。
@coderabbitai generate configuration
現在使われている設定内容をすべてYAML形式で出力します。GUI側で設定しておいて、このコマンドを実行すると、YAMLが得られます。
ただ、デフォルトの設定もすべて返ってくるので、大きなサイズのYAMLファイルになってしまいます。
@coderabbitai emit path instructions
こちらはディレクトリやファイル、拡張子を指定するレビュー観点の設定 path_instructions 以下の内容を返してくれます。現在のPRに合わせた内容となっています。ディレクトリ構成を変えた際などに実行すると良さそうです。
このコマンドでは、過去7日間に作成されたコードレビューへのフィードバックをベースにして生成されます。Learningsよりも path_instructions の方が強く効くので、定期的に実行すると path_instructions が磨かれるでしょう。
結果は別なPRとして送られます。
3. スキルを使う
非公式ですが、筆者が作っているスキルがあります。Claude Code用ですが、ファイルの配置を変えればCodexでも動くかと思います。
インストール後、 coderabbit-config というコマンドが使えるようになります。これは現在のファイル構成を読み取った上で、各種設定をウィザード形式で行えるものになります。
coderabbit-config自体はベストプラクティスベースの設定になるので、生成された .coderabbit.yaml を確認して、チームに合わせた設定へ修正してください。
まとめ
レビュー精度を高める際に、 path_instructions の設定は大事です。この設定が自動化できれば、より良いレビューが得られるようになります。
ぜひ .coderabbit.yaml を使って、チームの生産性を向上させてください。