Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

このコミットは、Go言語プロジェクトのAUTHORSファイルとCONTRIBUTORSファイルにおける、特定のメールアドレスのスペルミスを修正するものです。具体的には、Patrick Higgins氏とShawn Smith氏のメールアドレスが修正されています。

コミット

commit de7b8c50077ca0bfdcd59de488453df983f92ab3
Author: Russ Cox <rsc@golang.org>
Date:   Fri Aug 31 18:10:40 2012 -0400

    A+C: 0/2 on spelling email addresses correctly
    
    TBR=r
    CC=golang-dev
    https://golang.org/cl/6497067

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

https://github.com/golang/go/commit/de7b8c50077ca0bfdcd59de488453df983f92ab3

元コミット内容

A+C: 0/2 on spelling email addresses correctly

TBR=r
CC=golang-dev
https://golang.org/cl/6497067

このコミットメッセージは非常に簡潔で、AUTHORSとCONTRIBUTORSファイルにおけるメールアドレスのスペルミスを修正したことを示しています。A+CはAUTHORSとCONTRIBUTORSを指していると推測されます。0/2 on spelling email addresses correctlyは、2つのメールアドレスのスペルが間違っていたことを示唆しています。TBR=rはレビュー担当者（Russ Cox自身）を示し、CC=golang-devはGo開発者メーリングリストへの通知を示しています。https://golang.org/cl/6497067は、この変更がGoのコードレビューシステム（Gerritベース）でどのように扱われたかを示すChange-IDへのリンクです。

変更の背景

この変更の背景は、Goプロジェクトの公式な貢献者リストであるAUTHORSファイルとCONTRIBUTORSファイルに記載されているメールアドレスにスペルミスがあったためです。これらのファイルは、プロジェクトへの貢献者を正確に記録し、連絡先情報を提供する重要な役割を担っています。スペルミスは、連絡の不正確さや、公式な記録の誤りにつながるため、修正が必要とされました。

Goプロジェクトのような大規模なオープンソースプロジェクトでは、多くの貢献者が存在し、その情報を正確に管理することが重要です。このようなファイルのメンテナンスは、プロジェクトの健全性を保つ上で不可欠な作業の一部です。

前提知識の解説

AUTHORSファイルとCONTRIBUTORSファイル

多くのオープンソースプロジェクトでは、プロジェクトに貢献した人々を記録するためにAUTHORSファイルやCONTRIBUTORSファイルが使用されます。

  • AUTHORSファイル: 主にプロジェクトの主要な作者や、著作権を保持する個人・団体をリストアップするために使用されます。法的な意味合いを持つこともあります。
  • CONTRIBUTORSファイル: プロジェクトにコード、ドキュメント、バグ報告、アイデアなどで貢献したすべての個人をリストアップするために使用されます。こちらはより広範な貢献者を含みます。

これらのファイルは、プロジェクトの透明性を高め、貢献者への適切なクレジットを保証するために重要です。

Gitの差分表示 (diff)

Gitのdiffコマンドは、2つのコミット、ブランチ、または作業ディレクトリとインデックス間の変更点（差分）を表示するために使用されます。このコミットの差分表示では、--- a/AUTHORSと+++ b/AUTHORSのように、変更前のファイル（a）と変更後のファイル（b）が示され、行頭の+は追加された行、-は削除された行を示します。これにより、どの行がどのように変更されたかを視覚的に確認できます。

Goプロジェクトのコードレビュープロセス (Gerrit)

Goプロジェクトは、Gerritというコードレビューシステムを使用して変更を管理しています。開発者がコード変更を提案すると、それは「Change-ID」と呼ばれる一意の識別子を持つ変更リスト（Change List, CL）としてGerritにアップロードされます。レビュー担当者はこのCLを確認し、承認またはコメントを付けます。承認されたCLは最終的にGitリポジトリにマージされます。コミットメッセージに含まれるhttps://golang.org/cl/6497067のようなリンクは、このGerrit上のCLを指しています。

技術的詳細

このコミットは、テキストファイル内の文字列置換という非常に基本的な変更です。技術的な複雑さは伴いませんが、その正確性と、プロジェクトのメタデータ管理における重要性があります。

変更されたファイルは以下の通りです。

  • AUTHORS: プロジェクトの作者情報が記載されています。
  • CONTRIBUTORS: プロジェクトへの貢献者情報が記載されています。

これらのファイルはプレーンテキスト形式であり、各行に貢献者の名前とメールアドレスが記述されています。今回の変更は、既存の行のメールアドレス部分のスペルを修正するもので、行の追加や削除ではなく、既存の行の修正として記録されています。

具体的には、以下の2つのメールアドレスが修正されました。

  1. Patrick Higgins氏のメールアドレス:
    • 変更前: patrick.allen.higgens@gmail.com
    • 変更後: patrick.allen.higgins@gmail.com (末尾のsが削除)
  2. Shawn Smith氏のメールアドレス:
    • 変更前: shawnpsmith@gmail.com
    • 変更後: shawn.p.smith@gmail.com (.p.が追加)

これらの修正は、単なるタイポの修正であり、機能的な変更やコードの振る舞いに影響を与えるものではありません。しかし、プロジェクトの公式な記録の正確性を保つ上で重要な修正です。

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

diff --git a/AUTHORS b/AUTHORS
index 3da4bdb94f..1b274ce532 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -178,7 +178,7 @@ Paolo Giarrusso <p.giarrusso@gmail.com>
 Pascal S. de Kloe <pascal@quies.net>
 Patrick Crosby <patrick@stathat.com>
 Patrick Gavlin <pgavlin@gmail.com>
-Patrick Higgins <patrick.allen.higgens@gmail.com>
+Patrick Higgins <patrick.allen.higgins@gmail.com>
 Patrick Mylund Nielsen <patrick@patrickmn.com>
 Paul Lalonde <paul.a.lalonde@gmail.com>
 Paul Sbarra <Sbarra.Paul@gmail.com>
@@ -207,7 +207,7 @@ Sébastien Paolacci <sebastien.paolacci@gmail.com>
 Sergei Skorobogatov <skorobo@rambler.ru>
 Sergey 'SnakE'  Gromov <snake.scaly@gmail.com>
 Sergio Luis O. B. Correia <sergio@larces.uece.br>
-Shawn Smith <shawnpsmith@gmail.com>
+Shawn Smith <shawn.p.smith@gmail.com>
 Shenghou Ma <minux.ma@gmail.com>
 Spring Mc <heresy.mc@gmail.com>
 Stefan Nilsson <snilsson@nada.kth.se> <trolleriprofessorn@gmail.com>
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
index f4eb7860c6..3c0a643c42 100644
--- a/CONTRIBUTORS
+++ b/CONTRIBUTORS
@@ -256,7 +256,7 @@ Paolo Giarrusso <p.giarrusso@gmail.com>
 Pascal S. de Kloe <pascal@quies.net>
 Patrick Crosby <patrick@stathat.com>
 Patrick Gavlin <pgavlin@gmail.com>
-Patrick Higgins <patrick.allen.higgens@gmail.com>
+Patrick Higgins <patrick.allen.higgins@gmail.com>
 Patrick Mylund Nielsen <patrick@patrickmn.com>
 Paul Borman <borman@google.com>
 Paul Lalonde <paul.a.lalonde@gmail.com>
@@ -298,7 +298,7 @@ Sébastien Paolacci <sebastien.paolacci@gmail.com>
 Sergei Skorobogatov <skorobo@rambler.ru>
 Sergey 'SnakE' Gromov <snake.scaly@gmail.com>
 Sergio Luis O. B. Correia <sergio@larces.uece.br>
-Shawn Smith <shawnpsmith@gmail.com>
+Shawn Smith <shawn.p.smith@gmail.com>\n Shenghou Ma <minux.ma@gmail.com>
 Spring Mc <heresy.mc@gmail.com>
 Stefan Nilsson <snilsson@nada.kth.se> <trolleriprofessorn@gmail.com>

コアとなるコードの解説

このコミットは、GoプロジェクトのAUTHORSファイルとCONTRIBUTORSファイル内の特定の行を修正しています。これらのファイルは、プロジェクトの貢献者に関するメタデータをプレーンテキスト形式で保持しています。

差分表示を見ると、以下の変更が行われていることがわかります。

  1. AUTHORSファイルとCONTRIBUTORSファイルの両方で、Patrick Higgins氏のメールアドレスが修正されています。

    • 変更前: Patrick Higgins <patrick.allen.higgens@gmail.com>
    • 変更後: Patrick Higgins <patrick.allen.higgins@gmail.com>
    • higgensの最後のsが削除され、正しいスペルであるhigginsに修正されています。

  2. AUTHORSファイルとCONTRIBUTORSファイルの両方で、Shawn Smith氏のメールアドレスが修正されています。

    • 変更前: Shawn Smith <shawnpsmith@gmail.com>
    • 変更後: Shawn Smith <shawn.p.smith@gmail.com>
    • shawnpsmithがshawn.p.smithに修正され、名と姓の間に.p.が挿入されています。これは、メールアドレスの一般的な命名規則に合わせた修正であると考えられます。

これらの変更は、ファイルの内容を直接編集することで行われました。Gitはこれらの変更を差分として検出し、コミットとして記録しています。このコミットは、プロジェクトのメタデータの正確性を維持するための、典型的かつ重要なメンテナンス作業の一例です。

関連リンク

参考にした情報源リンク

  • Git公式ドキュメント: https://git-scm.com/doc
  • Gerrit Code Review: https://www.gerritcodereview.com/
  • 一般的なオープンソースプロジェクトのCONTRIBUTINGガイドライン (例: GitHubのドキュメントなど)
  • コミットメッセージの慣習に関する情報 (例: Conventional Commits)