クイックスタート
HeyDeer を GitHub に接続し、プルリクエストを 1 件レビューしてもらいます。
始める前に
- レビューしたいリポジトリへの書き込み権限を持つ GitHub アカウント。
- そのリポジトリのオープンなプルリクエスト。
- 組織の場合は、HeyDeer GitHub App をインストールするか、リクエストを承認できるオーナー。
新しいワークスペースは無料プランで開始します。初月は作成日から始まり、1,000 クレジットが含まれます。翌月以降は毎月 300 クレジットが含まれます。無料プランでは各リポジトリで同時に 1 件のレビューを実行でき、クレジットカードは不要です。クレジットを使い切った場合は、クレジットを追加購入するか、翌月の付与を待つか、有料プランを選択してください。詳しくはプランと追加クレジットをご覧ください。
1. サインインしてアカウントを選択する
GitHub でサインインします。リポジトリを接続で、個人アカウントまたは組織を選択します。一覧にない場合は、GitHub でインストールまたは別のアカウントにインストールを選択し、GitHub 上で選びます。
2. リポジトリを追加する
HeyDeer からリポジトリを求められた場合は、リポジトリを追加を選択します。GitHub で Only select repositories を選び、レビューするリポジトリを指定して確定します。HeyDeer がすでにリポジトリにアクセスできる場合、この手順は不要です。
組織では、あなたがオーナーでない限り、GitHub がオーナーに承認を求めます。GitHub App と権限を参照してください。アカウントやリポジトリが表示されない場合は、トラブルシューティングを参照してください。
HeyDeer がリポジトリにアクセスできるようになると、プッシュごとのレビュー（プルリクエストごとに最大 5 回）が始まり、レビューをカスタマイズが表示されます。そこで別のタイミングやレビューの深さを選ぶか、プルリクエストを自動でレビューをオフにして依頼があったときだけレビューするようにできます。この設定はいつでも変更できます。自動レビューを参照してください。
3. レビューを依頼する
プルリクエストに @heydeer review とコメントします。HeyDeer からレビューを開始することもできます。
👀 も返信もない場合は、トラブルシューティングを参照してください。
4. GitHub で結果を確認する
HeyDeer は指摘事項をレビューコメントとして投稿し、結果を HeyDeer Review チェックで報告します。チェックの Details リンクから、HeyDeer で完全なレポートを開けます。レビューの読み方を参照してください。
選んだ指摘事項を HeyDeer に修正させるには、レビューコメントでHeyDeer で修正を選択します。HeyDeer が別の PR を作成するので、それをレビューしてマージします。HeyDeer で修正を参照してください。
次のステップ
- HeyDeer がレビューするタイミングを選びます。自動レビューがまだオフの場合は、ワークスペース管理者がワークスペース設定 → レビュールール → レビューのタイミングでPR ごとに 1 回またはプッシュごとを選べます。自動レビューを参照してください。
- チームに合った構成を選びます：コードレビューのないチームまたは人のレビュアーがいるチーム。
- HeyDeer にコードベースを教えましょう。規約は AGENTS.md に、レビューのガイダンスは REVIEW.md に、HeyDeer に必ず検証させたい要件はリポジトリのチェックに書きます。HeyDeer が読み込む情報を参照してください。