[インデックス 19487] ファイルの概要
このコミットは、Goプロジェクトのドキュメントファイルである doc/contrib.html
に関連するものです。doc/contrib.html
は、Goプロジェクトへの貢献方法に関するガイドラインを提供するHTMLドキュメントであり、Goコミュニティへの参加、バグ報告、コードの貢献など、開発者がプロジェクトに関わる上で必要な情報やリソースへのリンクがまとめられています。
コミット
このコミットは、doc/contrib.html
ファイル内のリンク、メーリングリスト情報、およびGo 1.3のリリースノートへのリンクを更新することを目的としています。具体的には、古いリンクの修正、メーリングリストの整理と追加、そして最新のGoリリース(Go 1.3)に関する情報への参照が含まれています。
GitHub上でのコミットページへのリンク
https://github.com/golang/go/commit/8c9923d5e2e84cdba04355d6f48deb927cbd1c7e
元コミット内容
commit 8c9923d5e2e84cdba04355d6f48deb927cbd1c7e
Author: Shenghou Ma <minux@golang.org>
Date: Sun Jun 1 22:48:57 2014 -0400
doc/contrib.html: update links, mailing lists and link to 1.3 release note.
LGTM=adg
R=golang-codereviews, r, adg
CC=golang-codereviews
https://golang.org/cl/102020045
---
doc/contrib.html | 42 +++++++++++++++++++++++-------------------
1 file changed, 23 insertions(+), 19 deletions(-)
diff --git a/doc/contrib.html b/doc/contrib.html
index 048a5d97f0..6529c91d55 100644
--- a/doc/contrib.html
+++ b/doc/contrib.html
@@ -37,16 +37,13 @@ We encourage all Go users to subscribe to
A guide for updating your code to work with Go 1.
</p>
-<h4 id=\"go1.1notes\"><a href=\"/doc/go1.1\">Go 1.1 Release Notes</a></h4>
+<h4 id=\"release notes\"><a href=\"/doc/go1.1\">Go 1.1 Release Notes</a></h4>
<p>
-A list of significant changes in Go 1.1, with instructions for updating your
-code where necessary.
-</p>
-
-<h4 id=\"go1.2notes\"><a href=\"/doc/go1.2\">Go 1.2 Release Notes</a></h4>
-<p>
-A list of significant changes in Go 1.2, with instructions for updating your
-code where necessary.
+A list of significant changes in Go 1.1, with instructions for updating
+your code where necessary.
+Each point release includes a similar document appropriate for that
+release: <a href=\"/doc/go1.2\">Go 1.2</a>, <a href=\"/doc/go1.3\">Go 1.3</a>,
+and so on.
</p>
<h3 id=\"go1compat\"><a href=\"/doc/go1compat\">Go 1 and the Future of Go Programs</a></h3>
@@ -61,15 +58,22 @@ Go 1 matures.
<h3 id=\"source\"><a href=\"https://code.google.com/p/go/source\">Source Code</a></h3>
<p>Check out the Go source code.</p>
-<h3 id=\"golang-dev\"><a href=\"http://groups.google.com/group/golang-dev\">Developer Mailing List</a></h3>
-<p>The <a href=\"http://groups.google.com/group/golang-dev\">golang-dev</a>
-mailing list is for discussing and reviewing code for the Go project.</p>
+<h3 id=\"golang-dev\"><a href=\"https://groups.google.com/group/golang-dev\">Developer</a> and
+<a href=\"https://groups.google.com/group/golang-codereviews\">Code Review Mailing List</a></h3>
+<p>The <a href=\"https://groups.google.com/group/golang-dev\">golang-dev</a>
+mailing list is for discussing code changes to the Go project.\n+The <a href=\"https://groups.google.com/group/golang-codereviews\">golang-codereviews</a>
+mailing list is for actual reviewing of the code changes (CLs).</p>\n+\n <p>For general discussion of Go programming, see <a\n-href=\"http://groups.google.com/group/golang-nuts\">golang-nuts</a>.</p>\n+href=\"https://groups.google.com/group/golang-nuts\">golang-nuts</a>.</p>\n
-<h3 id=\"golang-checkins\"><a href=\"http://groups.google.com/group/golang-checkins\">Checkins Mailing List</a></h3>
+<h3 id=\"golang-checkins\"><a href=\"https://groups.google.com/group/golang-checkins\">Checkins Mailing List</a></h3>
<p>A mailing list that receives a message summarizing each checkin to the Go repository.</p>
+<h3 id=\"golang-bugs\"><a href=\"https://groups.google.com/group/golang-bugs\">Bugs Mailing List</a></h3>
+<p>A mailing list that receives each update to the Go <a href=\"http://golang.org/issue\">issue tracker</a>.</p>
+\n <h3 id=\"build_status\"><a href=\"http://build.golang.org/\">Build Status</a></h3>
<p>View the status of Go builds across the supported operating\n systems and architectures.</p>
@@ -77,13 +81,13 @@ systems and architectures.</p>
<h2 id=\"howto\">How you can help</h2>
-<h3><a href=\"http://code.google.com/p/go/issues\">Reporting issues</a></h3>
+<h3><a href=\"https://code.google.com/p/go/issues\">Reporting issues</a></h3>
<p>\n If you spot bugs, mistakes, or inconsistencies in the Go project\'s code or\n documentation, please let us know by\n-<a href=\"http://code.google.com/p/go/issues/entry\">filing a ticket</a>\n-on our <a href=\"http://code.google.com/p/go/issues\">issue tracker</a>.\n+<a href=\"https://code.google.com/p/go/issues/entry\">filing a ticket</a>\n+on our <a href=\"https://code.google.com/p/go/issues\">issue tracker</a>.\n (Of course, you should check it\'s not an existing issue before creating\n a new one.)\n </p>\n@@ -102,8 +106,8 @@ To get started, read these <a href=\"/doc/contribute.html\">contribution\n guidelines</a> for information on design, testing, and our code review process.\n </p>\n <p>\n-Check <a href=\"http://code.google.com/p/go/issues\">the tracker</a> for \n+Check <a href=\"https://code.google.com/p/go/issues\">the tracker</a> for \n open issues that interest you. Those labeled\n-<a href=\"http://code.google.com/p/go/issues/list?q=status=HelpWanted\">HelpWanted</a>\n+<a href=\"https://code.google.com/p/go/issues/list?q=status=HelpWanted\">HelpWanted</a>\n are particularly in need of outside help.\n </p>\n```
## 変更の背景
このコミットの背景には、主に以下の要因が考えられます。
1. **Go 1.3のリリース準備**: Go言語は定期的に新しいバージョンをリリースしており、Go 1.3のリリースが近づいていたため、関連するドキュメントを最新の状態に保つ必要がありました。特に、リリースノートへのリンクは、ユーザーが新しいバージョンの変更点や互換性に関する情報を確認するために不可欠です。
2. **リンクの陳腐化と更新**: ウェブサイトの構造変更、メーリングリストの移行、または単にURLの変更などにより、既存のリンクが古くなったり、機能しなくなったりすることがあります。貢献ガイドのような重要なドキュメントでは、常に最新かつ正確な情報を提供することが求められます。
3. **セキュリティとベストプラクティス**: `http://` から `https://` へのプロトコル変更は、ウェブのセキュリティ強化の一般的な傾向を反映しています。安全な接続を推奨するため、ドキュメント内のリンクもこれに合わせて更新されました。
4. **コミュニティリソースの明確化**: Goコミュニティは活発であり、複数のメーリングリストやコミュニケーションチャネルが存在します。これらの役割をより明確にし、貢献者が適切なチャネルにアクセスできるように、説明とリンクを更新する必要がありました。特に、`golang-dev` と `golang-codereviews` の役割分担を明確にしています。
5. **バグ報告プロセスの改善**: バグ報告に関するリンクも更新されており、ユーザーが問題を発見した際に、よりスムーズに報告できるような配慮がされています。
これらの変更は、Goプロジェクトのドキュメントの品質とユーザビリティを維持し、貢献者が最新の情報にアクセスできるようにするために行われました。
## 前提知識の解説
このコミットを理解するためには、以下の前提知識が役立ちます。
* **Go言語のリリースサイクル**: Go言語は、通常6ヶ月ごとにメジャーリリースを行います。各リリースには、新機能、パフォーマンス改善、バグ修正などが含まれ、その内容は「リリースノート」として公開されます。
* **`doc/contrib.html`**: これはGoプロジェクトの公式ドキュメントの一部であり、「Goプロジェクトへの貢献ガイド」として機能します。Goのソースコードに貢献したい開発者や、バグを報告したいユーザー向けに、必要な情報や手順、関連リソースへのリンクを提供します。
* **メーリングリスト**: ソフトウェア開発プロジェクトでは、コミュニティメンバー間のコミュニケーションのためにメーリングリストが広く利用されます。Goプロジェクトにも複数のメーリングリストがあり、それぞれ異なる目的を持っています。
* `golang-dev`: Goプロジェクトのコード変更に関する議論。
* `golang-codereviews`: 実際のコードレビュー(Change List: CLs)に関する議論。
* `golang-nuts`: Goプログラミング全般に関する一般的な議論。
* `golang-checkins`: Goリポジトリへの各コミットの要約を受信する。
* `golang-bugs`: GoのIssue Trackerへの更新を受信する。
* **Issue Tracker**: ソフトウェアプロジェクトにおけるバグ、機能リクエスト、その他の課題を追跡・管理するためのシステムです。Goプロジェクトも独自のIssue Trackerを使用しています。
* **HTMLとリンク**: `doc/contrib.html` はHTMLファイルであるため、`<a>` タグを用いたハイパーリンクの構造を理解している必要があります。リンクの `href` 属性が参照先のURLを指定します。
## 技術的詳細
このコミットにおける技術的な変更は、`doc/contrib.html` という単一のHTMLファイルに対するものです。変更の主な内容は以下の通りです。
1. **リリースノートのリンク更新と拡張**:
* Go 1.1およびGo 1.2のリリースノートへのリンクの記述が簡素化されました。
* 特に重要な変更として、Go 1.3のリリースノートへのリンクが追加されました。これにより、ユーザーは最新のリリース情報を簡単に参照できるようになりました。
* 以前は個別に記述されていたGo 1.1とGo 1.2のリリースノートのセクションが統合され、Go 1.1のリリースノートの説明文に、Go 1.2、Go 1.3以降のリリースノートも同様に提供される旨が追記されました。これは、将来のリリースにも対応できる汎用的な記述にすることで、ドキュメントのメンテナンス性を向上させる意図があります。
2. **メーリングリストのリンクと説明の更新**:
* 既存のメーリングリスト(`golang-dev`, `golang-nuts`, `golang-checkins`)のリンクが `http://` から `https://` へと更新されました。これはセキュリティ強化の一環です。
* `golang-dev` の説明がより詳細になり、`golang-codereviews` メーリングリストが新たに導入され、その役割(実際のコード変更のレビュー)が明確にされました。これにより、開発者は議論とコードレビューの適切なチャネルを区別できるようになります。
* `golang-bugs` という新しいメーリングリストへのリンクが追加されました。これはGoのIssue Trackerの更新を受信するもので、バグ追跡の透明性を高める目的があります。
3. **Issue Tracker関連リンクの更新**:
* バグ報告やIssue Trackerへのリンクも `http://` から `https://` へと更新されました。これにより、ユーザーが安全にバグを報告したり、既存のIssueを確認したりできるようになります。
* 特に「HelpWanted」ラベルが付いたIssueへのリンクも更新され、コミュニティからの貢献を促すための情報が最新の状態に保たれています。
これらの変更は、HTMLの `<a>` タグの `href` 属性の値を変更したり、新しい `<h4>` や `<h3>` セクション、`<p>` タグを追加したりすることで実現されています。
## コアとなるコードの変更箇所
```diff
--- a/doc/contrib.html
+++ b/doc/contrib.html
@@ -37,16 +37,13 @@ We encourage all Go users to subscribe to
A guide for updating your code to work with Go 1.
</p>
-<h4 id=\"go1.1notes\"><a href=\"/doc/go1.1\">Go 1.1 Release Notes</a></h4>
+<h4 id=\"release notes\"><a href=\"/doc/go1.1\">Go 1.1 Release Notes</a></h4>
<p>
-A list of significant changes in Go 1.1, with instructions for updating your
-code where necessary.
-</p>
-
-<h4 id=\"go1.2notes\"><a href=\"/doc/go1.2\">Go 1.2 Release Notes</a></h4>
-<p>
-A list of significant changes in Go 1.2, with instructions for updating your
-code where necessary.
+A list of significant changes in Go 1.1, with instructions for updating
+your code where necessary.
+Each point release includes a similar document appropriate for that
+release: <a href=\"/doc/go1.2\">Go 1.2</a>, <a href=\"/doc/go1.3\">Go 1.3</a>,
+and so on.
</p>
<h3 id=\"go1compat\"><a href=\"/doc/go1compat\">Go 1 and the Future of Go Programs</a></h3>
@@ -61,15 +58,22 @@ Go 1 matures.
<h3 id=\"source\"><a href=\"https://code.google.com/p/go/source\">Source Code</a></h3>
<p>Check out the Go source code.</p>
-<h3 id=\"golang-dev\"><a href=\"http://groups.google.com/group/golang-dev\">Developer Mailing List</a></h3>
-<p>The <a href=\"http://groups.google.com/group/golang-dev\">golang-dev</a>
-mailing list is for discussing and reviewing code for the Go project.</p>
+<h3 id=\"golang-dev\"><a href=\"https://groups.google.com/group/golang-dev\">Developer</a> and
+<a href=\"https://groups.google.com/group/golang-codereviews\">Code Review Mailing List</a></h3>
+<p>The <a href=\"https://groups.google.com/group/golang-dev\">golang-dev</a>
+mailing list is for discussing code changes to the Go project.\n+The <a href=\"https://groups.google.com/group/golang-codereviews\">golang-codereviews</a>
+mailing list is for actual reviewing of the code changes (CLs).</p>\n+\n <p>For general discussion of Go programming, see <a\n-href=\"http://groups.google.com/group/golang-nuts\">golang-nuts</a>.</p>\n+href=\"https://groups.google.com/group/golang-nuts\">golang-nuts</a>.</p>\n
-<h3 id=\"golang-checkins\"><a href=\"http://groups.google.com/group/golang-checkins\">Checkins Mailing List</a></h3>
+<h3 id=\"golang-checkins\"><a href=\"https://groups.google.com/group/golang-checkins\">Checkins Mailing List</a></h3>
<p>A mailing list that receives a message summarizing each checkin to the Go repository.</p>
+<h3 id=\"golang-bugs\"><a href=\"https://groups.google.com/group/golang-bugs\">Bugs Mailing List</a></h3>
+<p>A mailing list that receives each update to the Go <a href=\"http://golang.org/issue\">issue tracker</a>.</p>
+\n <h3 id=\"build_status\"><a href=\"http://build.golang.org/\">Build Status</a></h3>
<p>View the status of Go builds across the supported operating\n systems and architectures.</p>
@@ -77,13 +81,13 @@ systems and architectures.</p>
<h2 id=\"howto\">How you can help</h2>
-<h3><a href=\"http://code.google.com/p/go/issues\">Reporting issues</a></h3>
+<h3><a href=\"https://code.google.com/p/go/issues\">Reporting issues</a></h3>
<p>\n If you spot bugs, mistakes, or inconsistencies in the Go project\'s code or\n documentation, please let us know by\n-<a href=\"http://code.google.com/p/go/issues/entry\">filing a ticket</a>\n-on our <a href=\"http://code.google.com/p/go/issues\">issue tracker</a>.\n+<a href=\"https://code.google.com/p/go/issues/entry\">filing a ticket</a>\n+on our <a href=\"https://code.google.com/p/go/issues\">issue tracker</a>.\n (Of course, you should check it\'s not an existing issue before creating\n a new one.)\n </p>\n@@ -102,8 +106,8 @@ To get started, read these <a href=\"/doc/contribute.html\">contribution\n guidelines</a> for information on design, testing, and our code review process.\n </p>\n <p>\n-Check <a href=\"http://code.google.com/p/go/issues\">the tracker</a> for \n+Check <a href=\"https://code.google.com/p/go/issues\">the tracker</a> for \n open issues that interest you. Those labeled\n-<a href=\"http://code.google.com/p/go/issues/list?q=status=HelpWanted\">HelpWanted</a>\n+<a href=\"https://code.google.com/p/go/issues/list?q=status=HelpWanted\">HelpWanted</a>\n are particularly in need of outside help.\n </p>\n```
## コアとなるコードの解説
上記のdiffは、`doc/contrib.html` ファイルに対する具体的な変更を示しています。
* **リリースノートセクションの変更**:
* `-<h4 id=\"go1.1notes\"><a href=\"/doc/go1.1\">Go 1.1 Release Notes</a></h4>` と `-<h4 id=\"go1.2notes\"><a href=\"/doc/go1.2\">Go 1.2 Release Notes</a></h4>` が削除され、代わりに `+<h4 id=\"release notes\"><a href=\"/doc/go1.1\">Go 1.1 Release Notes</a></h4>` が追加されています。これは、Go 1.1と1.2のリリースノートへの個別の見出しを削除し、より一般的な「Release Notes」という見出しの下に統合したことを意味します。
* Go 1.1のリリースノートの説明文が変更され、`+Each point release includes a similar document appropriate for that\n+release: <a href=\"/doc/go1.2\">Go 1.2</a>, <a href=\"/doc/go1.3\">Go 1.3</a>,\n+and so on.` という行が追加されています。これにより、Go 1.2、Go 1.3、そしてそれ以降のリリースノートも同様に利用可能であることが明示され、将来のリリースへの対応が容易になります。
* **メーリングリストセクションの変更**:
* `golang-dev` メーリングリストのリンクが `http://` から `https://` に変更されています。
* `golang-dev` の見出しが `Developer Mailing List` から `Developer and Code Review Mailing List` に変更され、`golang-codereviews` メーリングリストへの新しいリンクと説明が追加されています。これは、開発者とコードレビューのメーリングリストの役割を明確にするためのものです。
* `golang-nuts` メーリングリストのリンクも `http://` から `https://` に変更されています。
* `golang-checkins` メーリングリストのリンクも `http://` から `https://` に変更されています。
* `golang-bugs` という新しいメーリングリストへのリンクと説明が追加されています。これは、GoのIssue Trackerの更新を受信するメーリングリストです。
* **Issue Trackerセクションの変更**:
* `Reporting issues` の見出しの下にあるIssue Trackerへのリンクが `http://` から `https://` に変更されています。
* バグ報告のためのチケット提出リンクも `http://` から `https://` に変更されています。
* 「HelpWanted」ラベルが付いたIssueへのリンクも `http://` から `https://` に変更されています。
これらの変更は、ドキュメント内の情報が最新かつ正確であり、ユーザーが安全なプロトコル(HTTPS)を使用して関連リソースにアクセスできるようにするためのものです。
## 関連リンク
* Go言語公式サイト: [https://golang.org/](https://golang.org/)
* Goプロジェクトのドキュメント: [https://golang.org/doc/](https://golang.org/doc/)
* Goのリリースノート一覧: [https://golang.org/doc/devel/release.html](https://golang.org/doc/devel/release.html) (一般的なリリースノートのページ、コミット当時のGo 1.3リリースノートへの直接リンクは `/doc/go1.3` の形式)
## 参考にした情報源リンク
* コミットメッセージとdiff: `/home/orange/Project/comemo/commit_data/19487.txt`
* Go言語のドキュメント構造とリリースプロセスに関する一般的な知識。
* HTTPSへの移行に関する一般的なウェブセキュリティのベストプラクティス。
* (Web検索ツールが利用できなかったため、外部のWebサイトからの直接的な情報収集は行っていません。)