Practical advice on writing effective release notes for software projects. The key principle is that release notes are a clerical document, not a marketing tool — they should lead with breaking changes and required upgrade steps, followed by a short list of flagship improvements and a detailed changelog. The recommended format is an annotated git tag using plaintext, leveraging git shortlog to auto-generate contributor summaries. A custom shell tool called 'semver' is mentioned to automate versioning and changelog generation. A real-world example from wlroots 0.12.0 illustrates the recommended structure.
Sort: