[インデックス 18131] ファイルの概要

このコミットは、Goプロジェクトの貢献ガイドラインを記述したdoc/contribute.htmlファイル内のメーリングリスト参照を更新するものです。具体的には、コードレビューに関するメーリングリストの指定をgolang-devからgolang-codereviewsに変更しています。

コミット

commit 2f5f1939233e121b7f45ce3b6ac17551fbf0d08b
Author: Shawn Smith <shawn.p.smith@gmail.com>
Date:   Sun Dec 29 11:11:28 2013 -0800

    doc/contribute: golang-dev -> golang-codereviews
    
    R=golang-codereviews, iant
    CC=golang-codereviews
    https://golang.org/cl/46320043

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/2f5f1939233e121b7f45ce3b6ac17551fbf0d08b

元コミット内容

doc/contribute: golang-dev -> golang-codereviews

これは、Goプロジェクトへの貢献方法を説明するドキュメントにおいて、コードレビューの宛先メーリングリストをgolang-devからgolang-codereviewsへ変更したことを示しています。

変更の背景

この変更の背景には、Goプロジェクトのコードレビュープロセスにおけるメーリングリストの役割分担の明確化があります。以前はgolang-devメーリングリストがGoプロジェクト全般の開発議論とコードレビューの両方に使用されていましたが、プロジェクトの規模拡大と貢献者の増加に伴い、コードレビューに特化したgolang-codereviewsメーリングリストが新設されたと考えられます。

これにより、開発に関する一般的な議論はgolang-devで、具体的なコード変更に関するレビューのやり取りはgolang-codereviewsで、と役割が分離され、情報の整理と効率的なコミュニケーションが図られるようになりました。このコミットは、その変更を公式ドキュメントに反映させるためのものです。

前提知識の解説

Goプロジェクトの貢献プロセス: Goプロジェクトへの貢献は、通常、Gerritというコードレビューシステムを通じて行われます。開発者は変更を提案する際に、Gerritにチェンジリスト（CL: Change List）をアップロードし、レビューを依頼します。レビューの過程で、レビュアーからのコメントや提案がGerrit上でやり取りされ、最終的に変更が承認されるとGoのリポジトリにマージされます。
メーリングリスト (golang-dev, golang-codereviews):
- golang-dev@googlegroups.com: Goプログラミング言語の開発に関する一般的な議論、提案、設計に関するコミュニケーションが行われる開発者向けのメーリングリストです。Goプロジェクトの広範な開発トピックが扱われます。
- golang-codereviews@googlegroups.com: このメーリングリストは、Goプロジェクトのコードレビューに特化しています。Gerritを通じて提出されたチェンジリストに関する通知、コメント、レビューの進捗状況などがこのリストに送信されます。これにより、特定のコード変更に関する詳細な議論が集中して行われます。
hg mail: これはMercurial（hg）バージョン管理システムで使用されるコマンドで、チェンジセット（コミット）をメーリングリストにメールとして送信するために使われます。GoプロジェクトはかつてMercurialを使用していましたが、後にGitに移行しました。このコミットの時点ではまだMercurialが使われていたため、hg mailコマンドがドキュメントに記載されています。

技術的詳細

このコミットは、doc/contribute.htmlファイル内の3箇所で、参照されているメーリングリストのURLとテキストをgolang-devからgolang-codereviewsに変更しています。

具体的には、以下の要素が変更されています。

コードレビューのデフォルト宛先: コードレビューのレビュアーフィールドを空にした場合に、デフォルトでレビューが送られるメーリングリストとしてgolang-dev@googlegroups.comが指定されていた箇所が、golang-codereviews@googlegroups.comに変更されました。
レビューテンプレートの更新: 貢献者がコードレビューを依頼する際に使用するテンプレートの例において、Reviewer:フィールドのデフォルト値がgolang-dev@googlegroups.comからgolang-codereviews@googlegroups.comに更新されました。
hg mailコマンドの例: hg mailコマンドを使用してチェンジセットをメールで送信する際の例において、-r（レビュアー）オプションで指定されるメーリングリストがgolang-dev@googlegroups.comからgolang-codereviews@googlegroups.comに変更されました。

これらの変更は、Goプロジェクトの貢献ガイドラインを最新のコードレビュープロセスに合わせるためのものであり、貢献者が正しいメーリングリストにコードレビューを送信できるようにするための重要な更新です。

コアとなるコードの変更箇所

--- a/doc/contribute.html
+++ b/doc/contribute.html
@@ -240,7 +240,7 @@ These can be code review nicknames or arbitrary email addresses.
 Unless explicitly told otherwise, such as in the discussion leading
 up to sending in the change list, leave the reviewer field blank.
 This means that the
-<a href="http://groups.google.com/group/golang-dev">golang-dev@googlegroups.com</a>
+<a href="http://groups.google.com/group/golang-codereviews">golang-codereviews@googlegroups.com</a>
 mailing list will be used as the reviewer.
 </p>
 
@@ -270,7 +270,7 @@ After editing, the template might now read:
 # Lines beginning with # are ignored.
 # Multi-line values should be indented.
 
-Reviewer: golang-dev@googlegroups.com
+Reviewer: golang-codereviews@googlegroups.com
 CC: math-nuts@swtch.com
 
 Description:
@@ -448,7 +448,7 @@ lines blank and then run:
 </p>
 
 <pre>
-$ hg mail -r golang-dev@googlegroups.com --cc math-nuts@swtch.com 99999
+$ hg mail -r golang-codereviews@googlegroups.com --cc math-nuts@swtch.com 99999
 </pre>
 
 <p>to achieve the same effect.</p>

コアとなるコードの解説

上記のdiffは、doc/contribute.htmlファイルに対する変更を示しています。

行 240-242:
- - <a href="http://groups.google.com/group/golang-dev">golang-dev@googlegroups.com</a>
- + <a href="http://groups.google.com/group/golang-codereviews">golang-codereviews@googlegroups.com</a> この変更は、コードレビューのレビュアーフィールドを空にした場合に、デフォルトでレビューが送られるメーリングリストのリンクと表示テキストをgolang-devからgolang-codereviewsに変更しています。これは、コードレビューの通知が新しい専用メーリングリストに送られるようになったことを反映しています。
行 270-271:
- - Reviewer: golang-dev@googlegroups.com
- + Reviewer: golang-codereviews@googlegroups.com この変更は、コードレビューのテンプレート例におけるReviewer:フィールドのデフォルト値を更新しています。これにより、貢献者がレビューを依頼する際に、正しいメーリングリストが自動的に設定されるようになります。
行 448-450:
- - $ hg mail -r golang-dev@googlegroups.com --cc math-nuts@swtch.com 99999
- + $ hg mail -r golang-codereviews@googlegroups.com --cc math-nuts@swtch.com 99999 この変更は、hg mailコマンドの使用例において、レビュアーを指定する-rオプションの値がgolang-devからgolang-codereviewsに変更されています。これは、Mercurialを使用してチェンジセットをメールで送信する際にも、コードレビュー専用のメーリングリストを使用すべきであることを示しています。

これらの変更はすべて、Goプロジェクトのコードレビュープロセスがgolang-codereviewsメーリングリストに移行したことをドキュメントに正確に反映させるためのものです。

参考にした情報源リンク

golang-dev vs golang-codereviews mailing list Go project のWeb検索結果

comemo