Update CHANGELOG.md, follow keepachangelog format #709
Conversation
CHANGELOG.md
Outdated
| ## [1.5.7](https://github.com/simplepie/simplepie/compare/1.5.6...1.5.7) - 2021-12-19 | ||
|
|
||
| * Fix PHP8 crash due to insufficient isset test by @Alkarex in #670 | ||
| * gitignore tests by @Alkarex in #671 |
There was a problem hiding this comment.
IMO, the changelog should be curated and not contain inconsequential stuff like CI changes. Author names are probably too noisy for it.
There was a problem hiding this comment.
The format stated that Changelogs should be written for humans. Since I copied the text from the release page, it means to me that the maintainers decided to keep this info in the Changelog, so did I. But removing or rewriting those changes could be done in this or an next PR. This is up to the maintainers.
There was a problem hiding this comment.
Yeah, I interpret being written for humans as reducing noise since humans do not deal with it very well. Similarly, reader probably does not care who contributed each feature so I would suggest moving acknowledgements into a paragraph at the end – there we can thank the contributors while keeping the list of changes clean. But yeah, this is largely up to maintainers and their preferences.
|
Some thoughts on backwards compatability. A comment from 2017 by @skyzyx suggests that this project adheres to Semver and that "we should be responsible about messaging BC breaks". (But I don't see that confirmed or documented anywhere.) The The first step would be for @mblaney to determine if SemVer is being adhering. The |
|
thanks @Art4 happy for you to keep the changelog updated |
I've noted that the
CHANGELOG.mdwas not updated since 1.5.5, so I updated it. And I formated the file to follow the keepachangelog.com format.I couldn't find a note if this project adheres to Semantic Versioning as I assumed in the CHANGELOG.md, so please correct me if I'm wrong.