Should we start a changelog?

[asinghvi17]

From some of the feedback in #975 it seems like a changelog requirement could be useful...

[rafaqz]

Yeah let's. Is there a helper bot for that?

[asinghvi17]

There is a ci that can check for the oatmeal of a changelog

[felixcremer]

We could adhere to https://keepachangelog.com/en/1.1.0/

That has some good tips on structuring a changelog.

[rafaqz]

Its a nice idea It has to be a lot better than this to be worth the effort:
https://github.com/rafaqz/DimensionalData.jl/releases/tag/v0.29.16

I'm not totally conviced it will be, it doesn't seem automatable so its directly using dev time

[JamesWrigley]

FWIW, my workflow is to always add a changelog entry when making a PR so that I don't forget it later on when making a release, and I use Changelog.jl for formatting. I think the advantage of a changelog over a list of PRs is that 1) it's easier to communicate breaking changes to users, and 2) you can skip changelog entries for things users don't care about (like improvements to tests or CompatHelper PRs). e.g. here's an example from a package I maintain: https://juliaimgui.github.io/ImGuiDocs.jl/cimgui/stable/changelog/

[JamesWrigley]

Oh, and this is a very handy site :) https://ichard26.github.io/next-pr-number/
I keep bookmarks for each package I maintain so whenever I make a PR I check the site to lookup the PR number for the changelog, saves having to figure it out manually or update the changelog after making the PR.

[rafaqz]

@JamesWrigley I addd this in #946, let me know if there could be any improvements to the approach. I realised we really have to write it iteratively in future, its hard to remember or find where something specifically happened 5 months ago and what it broke. But its a start.

[JamesWrigley]

Nice, I think that looks good 👍 The only thing I'd suggest is linking it somewhere in the docs?

(sorry for lazily not making a PR already, I've made a couple of attempts to work with vitepress but never got it building locally)