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

chore(CHANGELOG): switch to the keep a changelog format #115

Merged
merged 3 commits into from
May 1, 2024

Conversation

JKRhb
Copy link
Member

@JKRhb JKRhb commented May 1, 2024

As mentioned in #114 (comment), this PR introduces a new format for the CHANGELOG file based on Keep a Changelog to make changelogs a bit more readable in the future.

So far, only (some of) the most recent changes are described in this new format, but the goal should probably to apply the new format also to older releases. I am not sure yet whether I am going to this in this PR yet, though.

@JKRhb
Copy link
Member Author

JKRhb commented May 1, 2024

The changelog format is now also adjusted for older releases :) Some of the old changelog entries (but maybe even the new ones) could maybe be reworded, but I'll might revisit that later.

One thing that needs to fixed are the git tags linked at the bottom of the change – some of those are not existent for some reason. I will open an issue to keep track of that and merge this PR in the meantime.

@JKRhb JKRhb force-pushed the keep-a-changelog branch from 60000a0 to cba0fd1 Compare May 1, 2024 07:56
@JKRhb JKRhb marked this pull request as ready for review May 1, 2024 07:56
@JKRhb JKRhb enabled auto-merge May 1, 2024 07:56
@JKRhb JKRhb merged commit 7f8c7f2 into main May 1, 2024
4 checks passed
@JKRhb JKRhb deleted the keep-a-changelog branch May 1, 2024 07:57
@egekorkan
Copy link
Member

Can we do this for node-wot and other Thingweb components?

@JKRhb JKRhb added the Discuss in Committer Meeting Labels issues and PRs that should be discussed in our regular Thingweb Committer Meeting. label May 1, 2024
@JKRhb
Copy link
Member Author

JKRhb commented May 1, 2024

Can we do this for node-wot and other Thingweb components?

That would definitely be an option :) Maybe we can discuss this in one of the next meetings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discuss in Committer Meeting Labels issues and PRs that should be discussed in our regular Thingweb Committer Meeting.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants