より良いChangeLogを書くたの指針を示す「Keep a CHANGELOG」 | ソフトアンテナChangeLogとは、オープンソースプロジェクトで、バージョンごとにどのような新機能が追加されたか、どのような機能が変更されたのか等を説明するテキストファイルのこと。現状、特に書き方に決まりはなく、プロジェクトごとに自由な形式で書かれることが多いファイルです。 「Keep a CHANGELOG」はそんなChangeLogをより分かりやすく役に立つ形式で記述するための方法をまとめたドキュメントです。ファイルのフォーマットから、どのような事を書けばよいのかといった内容に関することまで事細かにまとめられています。 ChangeLogはかくあるべし このドキュメントでは、以下のChangeLogが良いものであるとされています。 機械のためではなく、人間のためのものなので、読みやすさはとても重要。 任意のセクションへのリンクが簡単であること(このためMarkdownはプレインテキストを超える)。
