Read more

How to write a good changelog

July 31, 2018Software engineer at makandra GmbH

We want to keep a changelog for all gems we maintain. There are some good practices Show snapshot for writing a changelog that adds value, please stick to these.

  • Add a notice to the README's contribute section about the changelog
  • For every release update the changelog
  • Note the date format yyyy-mm-tt

What is a changelog?

Illustration UI/UX Design

UI/UX Design by makandra brand

We make sure that your target audience has the best possible experience with your digital product. You get:

  • Design tailored to your audience
  • Proven processes customized to your needs
  • An expert team of experienced designers
Read more Show snapshot

A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project.

Why keep a changelog?

To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.

Who needs a changelog?

People do. Whether consumers or developers, the end users of software are human beings who care about what's in the software. When the software changes, people want to know why and how.


All notable changes to this project will be documented in this file.

This project adheres to [Semantic Versioning](

## Unreleased

- Added `Foo#foo` method.

## 1.0.0 - 2017-06-20

### Breaking changes

- Renamed `Foo` to `Bar`
- Removed `Baz#method`. Please use `Qax#method` instead.

### Compatible changes

- Added new `Bam#foo` method.

## 0.9.0 - 2017-05-20

### Compatible changes

- Improved performance of `Bam`.
Posted by Emanuel to makandra dev (2018-07-31 08:57)