GitHubでCODEOWNERSを設定して強制的にレビュー文化を作ろう

目標

GitHubでCODEOWNERSを設定してチーム開発において強制的にレビュー文化を作ろう。

CODEOWNERSの概要

CODEOWNERS ファイルを使い、リポジトリ中のコードに対して責任を負う個人あるいは Team を指定できます。

引用：https://docs.github.com/ja/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#example-of-a-codeowners-file

参考

設定方法

リポジトリに.githubディレクトリを作成してその下にCODEOWNERSというファイルを追加するだけ。

.github/
├── CODEOWNERS # これを追加
├── PULL_REQUEST_TEMPLATE.md
└── workflows
    └── auto-assign-author.yml

正しく指定できていると、GitHubから該当ファイルを見ると成功アラートのようなものが表示される。

CODEOWNERS

例えば、リポジトリ内のすべてのファイル変更に対してCODEOWNERSを指定するには次のように記述する。

# ref <https://docs.github.com/ja/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners>

* @kattakaha

ほかにもすべてのgoファイルに関して指定する場合は

*.go @kattakaha

などで指定できる。もちろん、特定ディレクトリ配下のみにCODEOWNERSを指定することも可能。

CODEOWNERSの設定ファイルの記述方法に関して、詳しくは公式ページをご覧ください。

作用

CODEOWNERSを設定すると、チームのメンバーがPull Requestを作成したときに自動的に指定されたCODEOWNERSに対してレビューが要求されるようにできる。