デザインレビューガイドライン

該当する場合、以下のガイドラインに従ってください。

V8 のデザインレビューを公式化するにあたっては、複数の動機があります。

  1. 個々の貢献者 (IC) に対して、誰が意思決定者であるかを明確にし、技術的な意見の不一致によってプロジェクトが進まない場合の今後の道筋を明確にする
  2. 率直な設計に関する議論を行うためのフォーラムを作る
  3. V8 テクニカルリード (TL) がすべての重要な変更を認識し、テクニカルリード (TL) レイヤーで意見を述べる機会を確保する
  4. 世界中のすべての V8 貢献者の関与を高める

概要 #

V8 のデザインレビューガイドラインの概要

重要

  1. 善意を前提とする
  2. 親切で礼儀正しくする
  3. 現実的である

提案された解決策は、以下の前提/柱に基づいています。

  1. 提案されたワークフローでは、個々の貢献者 (IC) が担当します。彼らはプロセスを促進する役割を担います。
  2. 彼らの指導を行う TL は、彼らが領域をナビゲートし、適切な LGTM 提供者を見つけるのを支援する役割を担います。
  3. 機能に議論の余地がない場合、オーバーヘッドはほとんど発生しません。
  4. 多くの議論がある場合、機能は V8 エンジニアリングレビューオーナー会議に「エスカレーション」され、そこでさらなる手順が決定されます。

役割 #

個々の貢献者 (IC) #

LGTM: 不要
この人は機能の作成者であり、設計ドキュメントの作成者です。

IC のテクニカルリード (TL) #

LGTM: 必須
この人は、特定のプロジェクトまたはコンポーネントの TL です。おそらく、この人はあなたの機能が影響を与える主要コンポーネントのオーナーです。TL が誰であるかが明確でない場合は、v8-eng-review-owners@googlegroups.com 経由で V8 エンジニアリングレビューオーナーに問い合わせてください。TL は、必要に応じて LGTM の必須リストにさらに人を追加する責任があります。

LGTM 提供者 #

LGTM: 必須
これは、LGTM を付与する必要がある人です。IC または TL(M) の場合があります。

ドキュメントの「ランダム」レビューア (RRotD) #

LGTM: 不要
これは、単に提案をレビューしてコメントする人です。彼らの LGTM は必須ではありませんが、彼らの意見は考慮されるべきです。

V8 エンジニアリングレビューオーナー #

LGTM: 不要
行き詰まった提案は、v8-eng-review-owners@googlegroups.com 経由で V8 エンジニアリングレビューオーナーにエスカレーションできます。このようなエスカレーションの潜在的なユースケース

V8 エンジニアリングレビューオーナーは、LGTM の付与/非付与を覆すことができます。

詳細なワークフロー #

V8 のデザインレビューガイドラインの概要
  1. 開始: IC が機能に取り組むことを決定/機能が割り当てられる
  2. IC は、初期の設計ドキュメント/説明/ワンページャーを数人の RRotD に送付します
    1. プロトタイプは「設計ドキュメント」の一部と見なされます
  3. IC は、LGTM を付与すべきだと考える LGTM 提供者のリストに人を追加します。TL は LGTM 提供者のリストに必須です。
  4. IC はフィードバックを組み込みます。
  5. TL は LGTM 提供者のリストにさらに人を追加します。
  6. IC は、初期の設計ドキュメント/説明/ワンページャーを v8-dev+design@googlegroups.com に送付します。
  7. IC は LGTM を収集します。TL は彼らを支援します。
    1. LGTM 提供者はドキュメントをレビューし、コメントを追加し、ドキュメントの先頭に LGTM または LGTM 非付与を付与します。LGTM を付与しない場合は、その理由を記載する必要があります。
    2. オプション: LGTM 提供者は、LGTM 提供者のリストから自分自身を削除したり、他の LGTM 提供者を提案したりできます
    3. IC と TL は、未解決の問題の解決に取り組みます。
    4. すべての LGTM が収集されたら、v8-dev@googlegroups.com にメールを送信します (例: 元のスレッドに ping を送信する)。そして実装を発表します。
  8. オプション: IC と TL がブロックされている場合や、より広範な議論をしたい場合は、問題を V8 エンジニアリングレビューオーナーにエスカレーションできます。
    1. IC は v8-eng-review-owners@googlegroups.com にメールを送信します
      1. TL は CC に含まれます
      2. メールに設計ドキュメントへのリンクを含めます
    2. すべての V8 エンジニアリングレビューオーナーメンバーは、ドキュメントをレビューし、オプションで LGTM 提供者のリストに自分自身を追加する義務があります。
    3. 機能のブロックを解除するための次の手順が決定されます。
    4. その後もブロッカーが解決されない場合、または新しい解決できないブロッカーが発見された場合は、8 に進みます。
  9. オプション: 機能が承認された後に「LGTM 非付与」が追加された場合は、通常の未解決の問題として扱う必要があります。
    1. IC と TL は、未解決の問題の解決に取り組みます。
  10. 終了: IC は機能の実装に進みます。

そして常に覚えておいてください

  1. 善意を前提とする
  2. 親切で礼儀正しくする
  3. 現実的である

FAQ #

機能が設計ドキュメントを持つ価値があるかどうかをどのように判断するのですか？ #

設計ドキュメントが適切な場合のいくつかのポイント

疑問がある場合は、TL に問い合わせてください。

LGTM 提供者のリストに誰を追加するかをどのように決定するのですか？ #

LGTM 提供者のリストに人を追加する必要がある場合のいくつかのポイント

「私の」TL は誰ですか？ #

おそらく、これはあなたの機能が影響を与える主要コンポーネントのオーナーです。TL が誰であるかが明確でない場合は、v8-eng-review-owners@googlegroups.com 経由で V8 エンジニアリングレビューオーナーに問い合わせてください。

設計ドキュメントのテンプレートはどこにありますか？ #

こちら.

何か大きな変更があった場合はどうなりますか？ #

明確で合理的な拒否期限を設けて LGTM 提供者に ping を送信するなどして、LGTM を引き続き保持していることを確認してください。

LGTM 提供者がドキュメントにコメントしません。どうすればよいですか？ #

この場合、以下のエスカレーションパスに従うことができます

誰かが私をドキュメントの LGTM 提供者として追加しました。どうすればよいですか？ #

V8 は、意思決定をより透明にし、エスカレーションをより簡単にすることを目指しています。設計が十分であり、実行されるべきだと考える場合は、自分の名前の横にあるテーブルセルに「LGTM」を追加してください。

ブロッキングとなる懸念や意見がある場合は、自分の名前の横にあるテーブルセルに「LGTM 非付与、理由: <理由>」を追加してください。別のレビューラウンドを依頼される準備をしてください。

V8 デザインレビューガイドラインは、V8 の Blink Intent+Errata プロセス を補完するものです。新しい WebAssembly または JavaScript 言語機能を立ち上げる場合は、V8 の Blink Intent+Errata プロセスと V8 デザインレビューガイドラインに従ってください。実装意図を送信する時点で、すべての LGTM を収集しておくことが理にかなっています。