What are some good practices for writing changelogs/update notes?

• kernel

  7 270 6.5 Rust

  The kernel for LibertyOS. (by LibertyOS-Development)

  

• conventional-changelog

  11 7,550 9.0 TypeScript

  Generate changelogs and release notes from a project's commit messages and metadata.

  

I dont use myself, but some people follows something like the conventional commit spec, and then uses a generator.

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• git-cliff

  33 7,536 9.7 Rust

  A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️

There is also this in my history browser: https://github.com/orhun/git-cliff

• changie

  26 582 8.9 Go

  Automated changelog tool for preparing releases with lots of customization options

Gitlab has a nice guide on how to write effective changelogs here https://docs.gitlab.com/ee/development/changelog.html They use a tool internally to organize files into changelogs during the release, python has a tool and so do a few others. I have created a generic tool that can be used in any project using go here: https://github.com/miniscruff/changie

• broot

  41 10,068 9.1 Rust

  A new way to see and navigate directory trees : https://dystroy.org/broot

Here's the changelog of one of my projects: https://github.com/Canop/broot/blob/master/CHANGELOG.md

• InfluxDB

  www.influxdata.com sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

Suggest a related project