syncthing / syncthing/syncthing

Keep A Changelog Formatted Release Notes

Open
#10,730 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement needs-triage
Dominant language
Go
Stars
88.8k
Forks
5.5k
Avg merge
2d 10h
Merged PRs (30d)
5

Description

Feature description

This request is related to documentation style.

May I recommend / request that release notes follow the specification outlined on keepachangelog.com? I've been following this methodology for years and really like it. It makes changes extremely visible and "screenable" when looking for fixes particular to particular issues. I suggest creating a template that can be reused with each release to quickly generate the formatted notes.

Problem or use case

I noticed in all recent change logs for more than a year, all changes for the last major release (e.g. 2.0) are also copied in every single minor release. This is excessively verbose. If people want to know the changes in the major release, they can look at the changelog / release notes for that specific version number as I've always done. It's really an extremely minor inconvenience, and even less so if you link to them in the app.

Alternatives or workarounds

None

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no repository files or tests. Start by reading the Keep a Changelog specification and inspecting recent release notes; done means release notes follow the requested format, use a reusable template, and avoid repeating major-release changes in each minor release.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.