"変更履歴" - 百科事典

変更履歴（またはchange logとも）は、プロジェクトに加えられたすべての重要な変更の記録またはログです。プロジェクトは通常ウェブサイトやソフトウェアプロジェクトであり、変更履歴にはバグ修正、新しい機能などの編集の記録が含まれます。オープンソースプロジェクトの一部では、変更履歴を配布のトップレベルファイルの一つとして含めています。

変更履歴は、歴史的にプロジェクトに加えられたすべての変更を含めていました。その代わりに、「プロジェクトの各バージョンごとに選別された、時系列的に並べられた重要な変更のリスト」を含めるべきであり、「git logのダンプ」ではないと提案されています。これは「誰にも役立たない」とされています。

GNU（Automake）のファイルの標準的な命名規則はChangeLogですが、時にはCHANGESやHISTORY（NEWSは通常、リリース間の変更ではなくコミット間の変更を反映する別のファイル）として別名で呼ばれます。別の慣習では、CHANGELOGと呼ぶことがあります。プロジェクトの管理者の中には、変更履歴がプレーンテキストの場合はファイル名に.txtの接尾辞を、Markdownの場合は.mdの接尾辞を、reStructuredTextの場合は.rstの接尾辞を付けることがあります。

いくつかのリビジョン管理システムは、変更履歴に含めるために関連する情報を生成することができます。

フォーマット
変更履歴ファイルは段落に構成されており、機能やファイル内のユニークな変更を定義します。

GNUコーディング基準では以下のフォーマットを推奨しています：

YYYY-MM-DD␣␣John Doe␣␣<johndoe@example.com>

* myfile.ext (myfunction): my changes made
additional changes.

* myfile.ext (unrelated_change): my changes made
to myfile.ext but completely unrelated to the above.

* anotherfile.ext (somefunction): more changes made by me.
日付と名前の間、および名前とメールアドレスの間にはそれぞれ2つのスペースがあります。メールアドレスは<と>で囲むことが一般的です。Emacsエディタは追加の変更履歴エントリを作成する際にこのようなエントリを作成します。

ウィキにおける変更履歴
ほとんどのウィキソフトウェアは変更履歴を基本機能として含んでいます（この文脈ではよく「履歴」と呼ばれます）。例えば、ウィキペディアエントリの上部の「履歴を表示」リンクはそのページの変更履歴にリンクしています。この機能は、ある著作権ライセンスのアトリビューション要件を満たすために非常に重要です。

プロダクトの変更履歴
プロダクトの変更履歴は、新しい機能、最新のリリース、関連するニュースについて顧客に情報を提供することができます。

参考
* もっと見る
* 脚注
* 外部リンク

GNU Coding Standards: Change Logs
変更履歴を保持する
変更履歴を作成するためのチェックリスト