クイックスタート
HeyDeer を GitHub に接続し、オープンなプルリクエストをレビューしてから、自動レビューをオンにします。レビューを開始するには、リポジトリへの書き込み権限が必要です。
1. ログインしてアカウントを選択する
heydeer.ai で「ログイン」を選択し、「GitHub で続行」を選択します。「GitHub アカウントを選択」で個人アカウントまたは組織を選び、「設定」を選択します。チームメイトがすでに設定している場合は「開く」を選択します。
2. GitHub App をインストールする
GitHub で Only select repositories を選び、レビューするリポジトリを選択してインストールします。組織のオーナーでない場合は、GitHub がオーナーに承認を依頼します。HeyDeer には「GitHub オーナーの承認を待っています」と表示され、承認されると接続されます。GitHub App と権限を参照してください。
3. 最初のプルリクエストのレビューを実行する
「レビュー」ページには、レビュー可能なオープンなプルリクエストが一覧表示され、最初の 1 件が選択されています。検索したりリポジトリで絞り込んだりするには「別の PR を選択」を選択し、次に「この PR のレビューを実行」を選択します。HeyDeer はリポジトリのデフォルトのレビューの深さとフィードバックの範囲を使用します。実行中はページを離れてもかまいません。
4. GitHub で結果を確認する
HeyDeer はインラインコメント付きのレビューを投稿し、HeyDeer Review チェックに結果が表示されます。以降のレビューでは新しいプッシュを確認し、対応済みのスレッドを解決済みにします。レビューの読み方を参照してください。
5. 自動レビューをオンにする
新しいワークスペースは「手動のみ」で始まります。管理者は「リポジトリ」でリポジトリを選択して「タイミングを変更」を選び、「PRごとに1回」または「プッシュごと」を選択します。または、「組織設定」→「レビュールール」で組織全体に設定します。自動レビューを参照してください。
6. HeyDeer にコードベースを教える
チームの規約を記述した AGENTS.md を追加し、特定の対象に絞ったルールには .agents/checks/ にリポジトリのチェックを追加します。
7. 通知先メールアドレスを設定する
管理者は、トライアル、クレジット、支払いに関するお知らせを受け取るワークスペースのメールアドレスを「組織設定」→「通知」で設定できます。通知を参照してください。
無料トライアル
新しいワークスペースには、1,200 クレジット付きの 14 日間の無料トライアルがあり、最初のレビューが成功した時点から始まります。レビューは一度に最大 2 件まで実行でき、クレジットカードは不要です。トライアルが終了するかクレジットを使い切ると、管理者がプランを選択するまで新しいレビューは一時停止します。プランと追加クレジットを参照してください。