ntfy icon indicating copy to clipboard operation
ntfy copied to clipboard

Keep a change log

Open theMarix opened this issue 6 years ago • 2 comments
trafficstars

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:

  • Support customizing or disabling the notification icon.
  • Support cusotmizing the notification timeout.
  • Have auto-ntfy ignore htop by default.
  • Make auto-ntfy send notifications in the background so that control returns to the shell faster.

theMarix avatar Nov 29 '18 20:11 theMarix

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

dschep avatar Nov 29 '18 20:11 dschep

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 :(

dschep avatar Nov 29 '18 20:11 dschep