DistributionチームのマージリクエストHandbook
はじめに
マージリクエストはDistributionエンジニア全員の責任です。基本的には、コードレビューのエンジニアリングプロセスに従います。
ワークフロー
DistributionチームはコードレビュープロセスでReviewers機能を使用しています。プロセスは以下のとおりです:
- 作者がプロジェクトにマージリクエストをオープンします。
- レビュー準備ができたら:
- マージリクエストにこの例のような自動Reviewer Rouletteコメントが含まれており、
danger-reviewCI/CDジョブが完了している場合:- 作者はReviewer Rouletteが提案したレビュアーに直接レビューをアサインし、"@gitlab-bot ready @username-of-someone"コマンドを使用して"workflow::ready for review"ラベルを適用します。
- そうでない場合:
- 作者が"workflow::ready for review"ラベルを適用します。
- レビュアーはDistributionマージリクエストレビュー準備完了ダッシュボードを優先度に応じて定期的に確認し、担当可能になったらReviewersセクションに自分を追加し"workflow::in review"ラベルを追加してマージリクエストを引き受けます。
- マージリクエストにこの例のような自動Reviewer Rouletteコメントが含まれており、
- 承認されたら、レビュアーはReviewersセクションにメンテナーを追加して最終レビュー/マージを依頼します。この時点で、レビュアーは自分をReviewerとして残すか(MRが引き続きリストに表示される)削除するかを決定できます。メンテナーにコメントがあれば、作者と連携して解決します。アサインされたMRに対応できないメンテナーは、別のメンテナーを見つける責任があります。
NOTE: SLOよりも早い対応が必要なマージリクエストに取り組んでいる場合は、gitlab-org/distributionグループを@メンションしてDistributionチームに通知してください。チームはこれらのリクエストへの対応にベストエフォートを発揮します。
レビュアー
デフォルトでは、プロジェクトのメンテナーでないすべてのDistributionエンジニアチームメンバーは自分自身をレビュアーとみなします。“workflow::ready for review"ラベルが付いたプロジェクトのマージリクエストを確認することに時間を使うことをお勧めします。
レビュアーはコントリビューターと協力して、最終レビューとマージのためにメンテナーに渡す前に、変更が私たちの基準を満たしていることを確認する責任があります。レビュアーはマージリクエストがリンクされたIssueで説明されている問題に対処しているかを確認します。また、該当するすべてのマージリクエストチェックリスト項目が完了していることを確認する責任もあります。チェックリスト項目が適用外の場合、レビュアーはそのアイテムが本当に不要であることを確認します。レビュアーとして、何かが私たちの基準を満たしているかどうかわからない状況に直面したとき、マージリクエスト内で直接メンテナーに質問してください。
また、「誰でもコントリビュートできる」という精神で、興味のある人はレビュアーになることをお勧めします。利用可能なマージリクエストのレビューを妨げる障壁はあるべきではありません。関心のあるすべての方の参加を歓迎します。
レビュアープロセスに積極的に参加する予定の人は、チームページのエントリを更新することをお勧めします。
レビューするマージリクエストを探すときは、マージリクエストレポートを確認して、SLOを超えそうなレビューを確認することを検討してください。
メンテナー
プロジェクトメンテナーは、特にレビュアーメンターシッププログラムに登録しているレビュアーが、自分が時間を費やす前にマージリクエストを確認するよう促することをお勧めします。メンテナーがレビュアーを待つことが合理的でない場合もあるため、ここでは判断が必要です。例えば、SLOを念頭に置く必要があります。MRがそのDeadlineを超えそうな場合、メンテナーは迷わず対応します。
マージリクエストのアサイン
これらすべてを実現するために、コントリビューターには、誰かが特定のマージリクエストを確認すべき理由がある場合を除き、初期レビューを求める際に個人にマージリクエストをアサインしないよう促します。むしろ、マージリクエストには"workflow::ready for review"ラベルを適用し、確認を始める際にレビュアーが自分自身をReviewersセクションに追加します。
マージリクエストが事前レビューなしにメンテナーに直接アサインされた場合、利用可能なレビュアーにアサインすることをお勧めします。レビュアーに直接アサインされた場合は判断を使ってください。すぐに対応できない場合は、別のレビュアーを見つけるようにしてください。
サービスレベル目標
取り組むマージリクエストを探す際は、GitLab Review-response SLOを検討してください。そのDeadlineを超えそうなものを最優先で確認します。
Distributionチームの負荷を考慮して、SLOは会社全体のものよりも長く設定されています:
- GitLabチームメンバーから: Review-response SLO < 4営業日
- Leading Organizationsの作者から: Review-response SLO < 6営業日
チームは、チームの拡大と技術的負債の解消に応じて、会社全体のSLO基準に戻ることを目指しています。
レビューのイテレーション
マージリクエストがレビュー中になったら、レビュアー/メンテナーと作者がフィードバックを通じてイテレーションを行う間、“workflow::in review"ラベルはマージリクエストに残しておきます。
変更や追加レビューのためにマージリクエストを引き渡す準備ができたら、次のステップに責任を持つ人をアサインし、マージリクエスト内でその人をメンションする新しいコメントでハンドオフをシグナルします。
NOTE: デフォルトでは、作者は以前レビューしたレビュアー/メンテナーにハンドオフします。そのメンバーのステータスが2日以上不在と表示されている場合は、gitlab-org/distributionグループを@メンションしてDistributionチームに新しいレビュアーを要請してください。
スカッシュとマージ
Distributionが所有するプロジェクトはデフォルトでsquash and mergeを有効にしています。この機能はマージリクエストのすべてのコミットをマージ前に1つのコミットにまとめ、ターゲットブランチのクリーンな履歴を確保します。
squash and merge機能はencourage(推奨)に設定されているため、作者は必要に応じてオプションを無効にできます。例えば、コミットが1つだけのマージリクエストはマージ前のスカッシュから必ずしも恩恵を受けるわけではありません。
参考
- Distributionチームのプロジェクト - Distributionチームが管理するプロジェクトの完全なリスト
- エンジニアリングプロジェクト - サポートされているGitLabプロジェクトの完全なリスト。プロジェクト名をクリックすると、各プロジェクトのメンテナーとレビュアーのリストが表示されます。
