Skip to content
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 CHANGELOG.md #98

Closed
hdamker opened this issue Jan 19, 2023 · 2 comments · Fixed by #99
Closed

Add CHANGELOG.md #98

hdamker opened this issue Jan 19, 2023 · 2 comments · Fixed by #99
Assignees

Comments

@hdamker
Copy link
Collaborator

hdamker commented Jan 19, 2023

In anticipation of the versioning guidelines from Commonalities there should be a CHANGELOG.md within the project.

Will generate an initial one from the release descriptions of v0.1.0 and v0.8.0.

Going forward a new release could be discussed and agreed by a pull request to the CHANGELOG.md. The merge commit of this pull request will be then tagged as the release (not for v0.8.0 as we are already beyond that point).

@hdamker hdamker self-assigned this Jan 19, 2023
@jlurien
Copy link
Collaborator

jlurien commented Jan 20, 2023

I just commented on the PR, but I copy the same here. I'm OK with taking that changelog from releases for the current status of the project, but we should follow the changelog template proposed in commonalities at some point, when the API is mature enough and we have to highlight the relevant changes between versions of the spec.

@hdamker
Copy link
Collaborator Author

hdamker commented Jan 20, 2023

@jlurien yes, that is more or less the outcome of the Github release feature, content generated there + notes in beginning - chore or similar PRs. I agree to sort the changes going forward in categories, but we need also improve the information within the PRs, e.g. with a (simple) template which might also allow to use tooling to reduce the work in release process.

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

Successfully merging a pull request may close this issue.

2 participants