-
-
Notifications
You must be signed in to change notification settings - Fork 24
Add a CHANGELOG file #147
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a CHANGELOG file #147
Conversation
|
Good point, thank you! In other repositories, we use a system in which we collect changelog entries in a specific directory. This has the advantage of not running into merge conflicts (which will always happen). I would rather introduce that system here first, and create a changelog file with the next release. There, we can also use https://keepachangelog.com/en/1.1.0/, and I could collect changelog entries from previous releases as well. |
Good point. I will add separate files in a dedicated folder. |
|
@MakisH I now put all the changelog entries since the last release in separate files, in |
|
I would still like to do some work on the same branch, give me a few days. |
Shall we merge this branch? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Taking another look, I think that this repository is not active enough to justify a changelog-entries/ workflow, which would be a bit more annoying (one has to first get the number of the PR to create the file). We can always reintroduce such a workflow without any changes to the file.
I added a CHANGELOG.md based on the keeachangelog format, and transferred the past entries from the Releases here, adjusting for consistency. I also added numbers and links to all PRs (besides the one for v2.20, which I think the commits were scattered).
Title is self-explanatory. I only added entries to the changelog after the last release.