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

This page summarizes the projects mentioned and recommended in the original post on reddit.com/r/opensource

Our great sponsors
  • SonarQube - Static code analysis for 29 languages.
  • OPS - Build and Run Open Source Unikernels
  • Scout APM - Less time debugging, more time building
  • GitHub repo kernel

    The kernel for LibertyOS. (by LibertyOS-Development)

  • GitHub repo conventional-changelog

    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.

  • SonarQube

    Static code analysis for 29 languages.. Your projects are multi-language. So is SonarQube analysis. Find Bugs, Vulnerabilities, Security Hotspots, and Code Smells so you can release quality code every time. Get started analyzing your projects today for free.

  • GitHub repo git-cliff

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

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

  • GitHub repo changie

    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

  • GitHub repo broot

    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

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts