Changelogs: For Humans, Not Machines

For anyone who has worked with me, they know I love a changelog and versioning. Whether it is because I sometime forget what I did a year ago, with different projects, technologies and methodologies all competing for brain space, or whether it is just so you can track what you released when, I find them an integral part of all software engineering… I’d love to see what others think I should add.

Changelog Guiding Principals

• Changelogs are for humans, not machines.
• There should be an entry for every single version.
• The same types of changes should be grouped.
• Versions and sections should be linkable.
• The latest version comes first.

I try to live this in my own examples Docker Ansible Changelog.