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

Make the changelog conform to the keepachangelog.com style #172

Merged
merged 1 commit into from
Oct 12, 2023

Conversation

edmorley
Copy link
Member

@edmorley edmorley commented Oct 12, 2023

The changelog intro says it conforms to the https://keepachangelog.com style, but previously the content actually did not. Now it does match that style, making it consistent with our other CNBs.

See:
https://keepachangelog.com/en/1.1.0/

I've also added links to the GitHub PRs for each entry. Whilst adding these is extra work for each PR, I feel it's worthwhile for end-users -- I very much find it useful when projects we use do the same.

GUS-W-14283439.

The changelog intro says it conforms to the https://keepachangelog.com style, but previously the content actually did not. Now it does match that style, making it consistent with our other CNBs.
@edmorley edmorley added the documentation Improvements or additions to documentation label Oct 12, 2023
@edmorley edmorley self-assigned this Oct 12, 2023
@edmorley edmorley marked this pull request as ready for review October 12, 2023 12:34
@edmorley edmorley requested a review from a team as a code owner October 12, 2023 12:34
@edmorley edmorley merged commit 48a4f98 into main Oct 12, 2023
5 checks passed
@edmorley edmorley deleted the edmorley/changelog-style branch October 12, 2023 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants