Skip to content

[Maintenance] Improve changelog and release notes #39

@shimonenator

Description

@shimonenator

Part 1

Currently, the changelog is a json file, which is not as easy to read for humans as it is for the machines. Switching it to a more common format like markdown would substantially improve accessibility, without much risk of breaking in-app change log functionality.

A one commonly used format for changelog files is documented here: https://keepachangelog.com/en/2.0.0/ (or its subset https://common-changelog.org/) but pretty much anything that's not a JSON would do.

Part 2

Currently, release notes include a very long description of how to install the app on all platforms, rather than what changed in this version. For those of us who read the Release section or receive an email notification, this is a completely useless information, largely unrelated to the release itself: installation is part of readme, and updates are already implemented as a small popup in the app.

Compare:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions