Changelog

[tarleb]

Please add a changelog to make it easier for downstream libraries to identify possible issues when a new major version is released.

[mauke]

Changelogs are not a documented feature of hackage/cabal.

[tfausak]

If you include a changelog.txt (or anything that passes isChangeLogFile) in your extra-doc-files, it will be rendered on Hackage. For example: https://hackage.haskell.org/package/witch-1.2.2.0/changelog.

[mauke]

I don't like relying on undocumented features.

[tarleb]

Personally, I'd just be happy to have some kind of human-readable documentation somewhere in the source repository. Changelog files are a fairly standard way to provide this. (I think some GNU projects use "anti-news" files that describe how features vanish as one goes back in time; whatever floats their boat.) If Hackage picks it up then that's a nice plus, but I'm happy as long as there's something.

[tarleb]

Thank you, much appreciated.