変更履歴

変更ログ（change log ^[1]とも表記）は、プロジェクトに加えられたすべての注目すべき変更のログまたは記録です。プロジェクトは多くの場合、Webサイトまたはソフトウェアプロジェクトであり、変更ログには通常、バグ修正、新機能などの変更の記録が含まれます。一部のオープンソースプロジェクトでは、変更ログを配布物の最上位ファイルの1つとして含めています。

これまで、変更ログにはプロジェクトに加えられたすべての変更が含まれていました。「Keep a Changelog」サイトでは、変更ログにすべての変更を含めるのではなく、「プロジェクトの各バージョンにおける注目すべき変更を時系列順にまとめたリスト」を含めるべきだと主張しており、git ログの「ダンプ」であってはならないとしています。「誰の役にも立たないからです」。^[2]

GNU ( Automake ) の標準的な命名規則ではChangeLogですが、^[3] CHANGESやHISTORYという別名が付けられることもあります( NEWSは通常、コミット間ではなくリリース間の変更を反映する別のファイルです)。別の規則では、CHANGELOGと呼ばれます。^[2]一部のプロジェクト管理者は、 changelog がプレーンテキストの場合はファイル名に.txtサフィックスを、Markdownの場合は.mdサフィックスを、reStructuredTextの場合は.rstサフィックスを追加します。

一部のリビジョン管理システムでは、すべての変更を反映させることが目的であれば、変更履歴に関連する情報を生成できます。^[4]

変更ログファイルは、関数またはファイル内の固有の変更を定義する段落ごとに構成されます。GNUコーディング標準では、次の形式が推奨されています。^[5]

YYYY-MM-DD␣␣ジョン・ドゥ␣␣<johndoe@example.com>

    * myfile.ext (myfunction): 変更を加えたもの
    追加の変更。

    * myfile.ext (unrelated_change): 私が行った変更
    myfile.ext ですが、上記とはまったく関係ありません。

    * anotherfile.ext (somefunction): 私が行ったさらなる変更。

日付と名前の間、および名前と電子メール アドレスの間には、それぞれ 2 つのスペースがあります。電子メール アドレスは、< と > で囲むのが一般的です。Emacsエディターは、追加の変更ログ エントリを作成するときに、このようなエントリを作成します。

ほとんどのウィキソフトウェアには、変更履歴(この文脈では履歴と呼ばれることが多い) が基本的な機能として含まれています。たとえば、Wikipediaエントリの上部にある^[6] 「履歴を表示」リンクは、そのページの変更履歴にリンクしています。この機能は、一部の著作権ライセンスの帰属要件に準拠するために不可欠です。^{[引用が必要]}

製品の変更ログにより、顧客に最新情報を知らせることができます。新機能、最新リリース、関連ニュースをアプリ内で直接発表するのに役立ちます。^{[引用が必要]}

• GNU コーディング標準: 変更ログ
• 変更履歴を保存する
• 変更ログを作成するためのチェックリスト

無料辞書の Wiktionary でchangelog を調べてください。