tweag / cooked-validators

MIT License
39 stars 11 forks source link

Add CHANGELOG.md #284

Closed florentc closed 1 year ago

florentc commented 1 year ago

This adds a changelog file that roughly follows https://keepachangelog.com guidelines. As agreed with @gabrielhdt, considering the amount of changes from v1, the changelog for V2 is kept extremely concise and high level. It would quickly turn into a documentation if we were to detail every single item, and as mentioned on https://keepachangelog.com, changelogs that are paraphrasing git logs are not very useful.

Feel free to add and modify elements (in particular deprecations or other API changes that would be important to mention).

We should also mention which versioning template we use (for now it is semantic versioning but we were discussing about switching to Haskell PVP).