heydeer

よくある質問

導入前後にチームからよく寄せられる質問をまとめました。セットアップ、レビュー、修正、料金、セキュリティまで網羅しています。

はじめに

HeyDeer をセットアップするには?

GitHub を接続し、リポジトリを選んでから、レビューを依頼します。

  • GitHub でサインインし、リポジトリがあるアカウントを選ぶで個人アカウントまたは組織を選びます。一覧にない場合は、GitHub でインストールを選択して GitHub 側で選びます。
  • GitHub で Only select repositories を選び、レビューするリポジトリを指定して確定します。組織では、あなたがオーナーでない限り、GitHub がオーナーに承認を求めます。
  • HeyDeer に自動でレビューさせるかを決めます。プルリクエストを自動でレビューをオンのままにするとプッシュのたびにレビューし(1 つのプルリクエストにつき最大 5 回)、オフにすると依頼したときだけレビューします。
  • オープン中のプルリクエストに @heydeer review とコメントします。

リポジトリへの書き込み権限が必要です。新しいワークスペースはクレジットカード不要の無料プランで始まり、指摘事項はプルリクエストのレビューコメントとして届きます。

詳しく見る: クイックスタート
HeyDeer は GitLab や Bitbucket でも使えますか?
HeyDeer は GitHub で利用でき、公開・非公開のリポジトリ、組織、個人アカウントのいずれにも対応しています。GitHub App としてインストールされ、読み取りとレビューを許可するリポジトリは自分で選ぶため、アクセスはレビューしてほしいコードだけに限られます。各ワークスペースは 1 つの GitHub アカウントに属します。別のアカウントを接続するには、ワークスペースメニューでワークスペースを追加を選択します。
詳しく見る: GitHub App と権限
最初のレビューの前に設定は必要ですか?

接続したらすぐにレビューを依頼できます。HeyDeer はプルリクエストの変更をリポジトリ全体の文脈の中で読み、PR のタイトル、説明、議論もあわせて確認します。どのレビューも最初からバグとセキュリティの問題を探します。

最初のレビューで足りない点が見えたら、適切な場所にガイダンスを追加します。

  • AGENTS.md:コードの仕組みと、従っている規約。コーディングエージェントもこのファイルに従います。
  • REVIEW.md:レビューで探すべきこと、触れずにおくこと、問題の深刻度。
  • リポジトリのチェック:特定のファイルを変更するすべてのプルリクエストで、HeyDeer が必ず検証すべき要件。
  • レビューへの指示:プルリクエストで変更されては困るガイダンスや、すべてのリポジトリに適用するガイダンス。
詳しく見る: HeyDeer が読み込む情報
HeyDeer はいつプルリクエストのレビューを始めますか?

誰かが依頼すればすぐに始まります。プルリクエストに @heydeer review とコメントするか、レビュー履歴ページでレビューを開始を選択するか、HeyDeer Review チェックで Re-run を選択します。新しいワークスペースは手動のみで始まり、セットアップの直後に HeyDeer が自動でレビューするかどうかを尋ねます。

ワークスペース管理者は、ワークスペース設定 → レビュールール → レビューのタイミングでいつでもスケジュールを変更できます。

  • PR ごとに 1 回:条件に合うプルリクエストを、レビューが 1 回成功するまでレビューします。
  • プッシュごと:プルリクエストが初めてフィルターに一致したときと、その後コミットを追加するプッシュのたびにレビューします。デフォルトでは最大 5 回です。

自動レビューは、デフォルトでドラフト、フォーク、依存関係の更新をスキップします。

詳しく見る: 自動レビュー
HeyDeer が GitHub オーナーの承認待ちと表示されるのはなぜですか?
GitHub の組織では、HeyDeer GitHub App をインストールできるのはオーナーだけです。そのため、ほかの人が接続すると GitHub がオーナーにリクエストを送り、HeyDeer にはGitHub オーナーの承認を待っていますと表示されます。ワークスペース管理者はこの待ち時間に設定を済ませておけるので、最初から思いどおりの形でレビューを始められます。オーナーが GitHub で承認するとワークスペースは自動的に接続され、HeyDeer からワークスペースの通知メールアドレスにメールが届きます。
詳しく見る: GitHub App と権限
リポジトリを追加するには?
リポジトリページでリポジトリを追加を選択するか、ワークスペース設定 → GitHub 接続でGitHub のアクセス権を管理を選択し、GitHub でリポジトリを選びます。変更を保存できるのは GitHub アカウントのオーナーだけです。それ以外の人にはチームに依頼が表示され、コピーしてオーナーに送れる依頼文が用意されます。追加したリポジトリはレビュールールのワークスペースのデフォルトに従うので、すぐにほかのリポジトリと同じようにレビューされます。今後作成するリポジトリも含めるには、GitHub ですべてのリポジトリを選びます。
詳しく見る: GitHub App と権限
チームに HeyDeer をどう展開すればよいですか?

段階的に導入し、チームが結果を信頼できるようになったら、HeyDeer の結果をマージの条件にしましょう。

  • いくつかのプルリクエストで試す:自動レビューをオフにしたまま、種類の異なるプルリクエストいくつかに @heydeer review とコメントし、指摘事項をチームのレビュアーの指摘と比べます。
  • そのレビューで見えた不足を埋める:規約は AGENTS.md、要件はリポジトリのチェック、優先事項はレビューへの指示に書きます。
  • 1〜2 個のリポジトリで自動レビューをオンにし(リポジトリで選択してからタイミングを変更)、その後ワークスペース全体に広げます。
  • HeyDeer Review チェックを必須にし、自動承認を使うかどうかを決め、有料プランなら自動チャージと使用量の上限を設定します。

チームが大半の指摘事項に対応し、レビューが注意事項なしで完了するようになったら、次の段階に進みます。設定を変更するのはワークスペース管理者で、書き込み権限があれば誰でもレビューを依頼できます。

詳しく見る: チームへの展開
チームに見せる前に HeyDeer を試せますか?
はい。ワークスペース設定 → レビュールール → 結果の公開で、GitHub チェックを公開とPR にレビューコメントを投稿をオフにします。そのうえでレビュー履歴ページのレビューを開始からレビューを依頼し、結果をそこで確認します。結果は HeyDeer の中にだけ表示されます。レビューは通常どおり実行され、クレジットも消費します。チームとレビューを共有する準備ができたら、両方のオプションをオンに戻します。
詳しく見る: 結果の公開
HeyDeer が依頼を受け付けたかどうかは、どうすればわかりますか?
HeyDeer は依頼を受け付けるとあなたのコメントに 👀 を付け、レビューが終わると外して、プルリクエストにレビューを投稿します。その間、HeyDeer Review チェックにレビューの進捗が表示されます。HeyDeer がレビューを実行できない場合や、レビューが失敗またはキャンセルされた場合は、HeyDeer があなたのコメントに返信します。👀 が付かないコメントは、コマンドとして読み取られていません。コード、引用、編集ではなく、新しいコメントにプレーンテキストで投稿してください。
詳しく見る: PR コメントのコマンド
レビュー結果はどこで確認できますか?
プルリクエスト上で確認できます。HeyDeer は指摘事項を GitHub のレビューとして投稿し、各指摘事項が対象とする行にインラインコメントを付けます。差分の外にあるコード(変更によって動かなくなる、変更されていない呼び出し元など)に関する指摘事項は、レビュー本文のその他の指摘事項に表示されます。HeyDeer Review チェックが結果を報告し、その詳細リンクから HeyDeer で完全なレポートを開けます。HeyDeer のレビュー履歴ページには、すべてのレビューが一覧表示されます。ウォークスルーボタンを押すと、関連する編集をまとめて重要なものを強調した変更のガイドが開き、次にプルリクエストを読む人の助けになります。
詳しく見る: レビューの読み方
コーディングエージェントが作成したプルリクエストも HeyDeer はレビューしますか?
はい。コーディングエージェントやその他のボットからのプルリクエストも、ほかと同じようにレビューされます。HeyDeer は、そのプルリクエストを書いたエージェントとは切り離して 1 件ずつレビューします。エージェントは自分のミスを見落としがちなので、これが重要です。また、その後のプッシュでは以前の問題を再確認します。デフォルトの自動レビューのフィルターがスキップするのは、ドラフト、フォーク、そして Dependabot や Renovate などのボットによる依存関係の更新だけです。HeyDeer が承認したエージェントのプルリクエストをマージするには、コードレビューを行わないチーム向けのセットアップに従ってください。
詳しく見る: コードレビューのないチーム

解決しませんでしたか?

HeyDeer を開発するチームにチャットで相談するか、メールでお問い合わせください。