コードレビュー
ガイドライン
Code Review Guidelines
Skip to content
はじめに
プログラマが知るべき97のこと の14個目に「コードレビュー」について記述がある。コードレビューの目的は「コードの質を上げ、欠陥を減らすため」だけではなく、「チーム全員に同じ知識を共有させること、またコーディングにおいて全員が守るべきガイドラインを確立すること」が大切だとある。そして「 レビューを楽しいものにすること」がおそらく最も有効だとある。
コードレビューを楽しい場にするためにも、レビュアー／レビュイー が同じ方向性を向くことが重要である。同時に、人によってコメントなどの表現が揺れ、それにより認識齟齬があると楽しむ以前の問題であるため、守るべきルールも存在するはずである。このガイドラインは推奨する行動と、守るべきルールの両方を定義し、コードレビューをより有意義で学びが多く、生産性と品質を高める場とすることを目指す。
参考
コードレビューとは | GitLab にも似た旨の記載がある
免責事項
- 有志で作成したドキュメントである。フューチャーには多様なプロジェクトが存在し、それぞれの状況に合わせて工夫された開発プロセスや高度な開発支援環境が存在する。本ガイドラインはフューチャーの全ての部署／プロジェクトで適用されているわけではなく、有志が観点を持ち寄って新たに整理したものである
- 相容れない部分があればその領域を書き換えて利用することを想定している。プロジェクト固有の背景や要件への配慮は、ガイドライン利用者が最終的に判断すること。本ガイドラインに必ず従うことは求めておらず、設計案の提示と、それらの評価観点を利用者に提供することを主目的としている
- 掲載内容および利用に際して発生した問題、それに伴う損害については、フューチャー株式会社は一切の責務を負わないものとする。掲載している情報は予告なく変更する場合がある
適用範囲
GitHubやGitLabなどのサービスを利用した、コーディングについてのレビューのみを対象とする。
プロジェクト計画によっては、開発プロセスを複数の「フェーズ」に分割し、各フェーズの終了時点で「フェーズレビュー」を挟むようなケースも考えられるが、それらは対象外とする。
定義
| 用語 | 説明 |
|---|---|
| レビュアー | レビューを行う側の担当者 |
| レビュイー | レビューを依頼する側の担当者。プルリクエストを起票する開発者でもある |
| プルリクエスト | GitLabではマージリクエストともいうが、本ガイドラインではプルリクエストに統一して呼称する |
謝辞
このアーキテクチャガイドラインの作成には多くの方々にご協力いただいた。心より感謝申し上げる。
- 作成者: 真野隼記、村田靖拓、山本竜玄、清水雄一郎、水田祐介
- レビュアー: 谷村元気、栗田真、後藤玲雄、八木雅斗、辻大志郎
Articles
- 2025.05.02 コードレビューガイドラインを公開しました