Skip to main content
GitHubにKodusをセットアップするには数分かかります。接続されると、すべてのプルリクエストが自動的にレビューされます。

手順

  1. kodus.ioでアカウントを作成するか、Kodusをセルフホストします
  2. GitHubに接続 — オンボーディングの Connect your Git tool ステップで Install Github app をクリックします(後からサイドバーの Repositories から接続することもできます)
  3. リポジトリを選択 — Kodusがレビューすべきリポジトリを選択します
  4. PRをオープン — Kodusが自動的にレビューしてコメントを投稿します

得られるもの

  • すべてのPRでの自動レビュー(またはオンデマンドで @kody start-review)
  • コード提案付きでPR内に直接投稿されるコメント
  • カスタマイズ可能なルール、レビューカテゴリ、最小重要度のしきい値
  • リンクされたタスクに対するビジネスロジック検証

カスタム設定

リポジトリごとの動作をカスタマイズするには、リポジトリルートに kodus-config.yml を配置します。そのリポジトリで kodus Config File Overrides Web Preferences がオンになっている場合(Code review → General)、ファイルはウェブ設定をオーバーライドします。

個人アクセストークンの使用

プライベートリポジトリやより厳格な権限を持つ組織では、GitHub個人アクセストークン(PAT)を設定する必要がある場合があります。オンボーディングで Connect via token を選択します(または Repositories でGitHubを接続する際の Token タブ)。この場合、レビューはトークン所有者のアカウントから投稿され、GitHub Checks/PRステータスは利用できません。 完全なセットアップガイドについては、クイックスタートとGitHub Appセットアップを参照してください。