search

release-it / keep-a-changelog

Keep a Changelog plugin for release-it
MIT License
27 stars 15 forks source link

Write what this plugin does #30

Closed gander closed 1 year ago

gander commented 1 year ago

Not everyone has time to solve puzzles as to why this plugin is not working. This plugin works. It does what it was designed to do, but there is no information as to what it actually does? If I immediately found out that this plugin replaces the ## [Unreleased] header with the current version and release date, it would be clear that this is not what I expected from it. But there is no such information, so I wasted a lot of time to discover it. Sorry, just stating that you adhere to some standard is not exhaustive information about what this plugin does.

gander commented 1 year ago

Has anything changed since the last comment?

webpro commented 1 year ago

Yes, there have been some changes and releases since. Agreed the docs aren't very extensive. Anybody can feel free to open a pull request and improve it.