keep-a-changelog VS semver

A style guide for changelogs, adapted from and a stricter subset of [Keep a Changelog](https://keepachangelog.com/)

not entirely related to your question, but worth a read : https://keepachangelog.com/

A Changelog should be written for each release, conforming to the standard https://keepachangelog.com/

I agree, I used to have a NEWS file in my projects (later a NEWS.md), but as others commented, the signification of the term "changelog" has changed. Sites like https://keepachangelog.com/ really refers to release notes or news.

Overall I like the format and advice from https://keepachangelog.com/

We’ve adopted it at work and it’s nice to have a consistent format that is relatively noise free.

You can read more about it at: https://keepachangelog.com/

# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [0.0.4] - 2014-08-09 ### Added - Better explanation of the difference between the file ("CHANGELOG") and its function "the change log". ### Changed - Refer to a "change log" instead of a "CHANGELOG" throughout the site to differentiate between the file and the purpose of the file — the logging of changes. ### Removed - Remove empty sections from CHANGELOG, they occupy too much space and create too much noise in the file. People will have to assume that the missing sections were intentionally left out because they contained no notable changes. ## [0.0.3] - 2014-08-09 ### Added - "Why should I care?" section mentioning The Changelog podcast. ## [0.0.2] - 2014-07-10 ### Added - Explanation of the recommended reverse chronological release ordering. ## [0.0.1] - 2014-05-31 ### Added - This CHANGELOG file to hopefully serve as an evolving example [Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...HEAD [0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4 [0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3 [0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2 [0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1

Following the Semantic Versioning rules, you should raise the version number every time you need to publish your library. In your "package.json" file, you need to change the version number to reflect whether the changes are major, minor, or patch updates.

Semantic Versioning: An established convention for version numbers following the pattern MAJOR.MINOR.PATCH

Increases the major of the latest tag and prints it As per the Semver spec, it'll also clear the pre-release…

The reason for this is that software libraries and package managers, in general, but specifically here, rely on semantic versioning. Semantic versioning is really useful for distributing packages in a predictable way. What does this look like for our project?

For a more detailed and comprehensive guide on semantic versioning, visit https://semver.org

I believe neovim follows semantic versioning. https://semver.org/

Semver has been 2.0.0 for 10 years, look at the date of the assets. Multiple releases created today where none existed before. Not sure why someone is creating releases now, perhaps just some housekeeping/cleanup.

https://github.com/semver/semver/releases

All ELRS hardware will talk to all other ELRS hardware, including Radiomaster's ELRS transmitters and receivers. There are one or two exceptions from scummy companies that have been pilloried by the community, and you probably won't find them anymore. So long as the ELRS firmware running on both devices has the same major version number, you're good to go. ie. 3.3.1 will still talk to 3.0.1, but won't talk to 2.0.0. (The "major version" is the 1st number, the "minor version" is the 2nd number, and the "patch version" is the 3rd number. See Semantic Versioning for more info.)

If you're using semver, read the spec it's not overly long or hard to understand.

Semantic versioning actually has a clear rule about this: