Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Add a changelog #319

Open
nbaksalyar opened this issue Apr 15, 2022 · 1 comment
Open

Add a changelog #319

nbaksalyar opened this issue Apr 15, 2022 · 1 comment

Comments

@nbaksalyar
Copy link
Contributor

Since breaking changes are inevitable, I think introducing a changelog would be a good idea.

I propose to follow the format described on keepachangelog.com. Usually, it's not a huge maintenance burden: contributors guide can be updated to require updating the changelog with each PR (especially if the change is breaking).

@rsdy
Copy link
Collaborator

rsdy commented Apr 19, 2022

We are currently tracking changes on the Releases page, which is reasonably easy to extract from the git logs. However, I would generally not approve of any "better" change tracking mechanism that we can't enforce through a CI check.

If you have any suggestions, then we could probably have a conversation on setting up a policy to make this easier.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants