dschep / ntfy

🖥️📱🔔 A utility for sending notifications, on demand and when commands finish.
http://ntfy.rtfd.io
GNU General Public License v3.0
4.83k stars 214 forks source link

Keep a change log #188

Open theMarix opened 5 years ago

theMarix commented 5 years ago

It would be neat if a change log was kept in the repository or the documentation so that I, as a user or distribution package maintainer, can get an overview of new capabilities and changed behaviour in new versions without having to read through all commits.

The problem with reading through commit logs is that they are noisy and written from the perspective of how the code changes. A change log could focus on what changes for a user. E.g, the entry for version 2.7.0 could look like this:

dschep commented 5 years ago

Thanks for pushing me to maintain best practices. I'll see what i can do when i have time.

dschep commented 5 years ago

btw, most release tags have at least some info: https://github.com/dschep/ntfy/tags

looks like i dropped the ball after 2.5 tho :(