dschep / dschep/ntfy

Keep a change log

Open
#188 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
5k
Forks
216
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.