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

3.0.0: Add changelog #792

Merged
merged 1 commit into from
Sep 4, 2023
Merged

3.0.0: Add changelog #792

merged 1 commit into from
Sep 4, 2023

Conversation

GaryJones
Copy link
Contributor

No description provided.

@GaryJones GaryJones added this to the 3.0.0 milestone Aug 31, 2023
@GaryJones GaryJones requested a review from jrfnl August 31, 2023 15:44
@GaryJones GaryJones self-assigned this Aug 31, 2023
@GaryJones GaryJones requested a review from a team as a code owner August 31, 2023 15:44
Copy link
Collaborator

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GaryJones Thanks for setting this up.

Verified that all merged PRs are mentioned ✔️

Additional notes:

  • "Props" are missing. Not something I'm really concerned about as it's only the two of us, but all previous changelogs have them, so for consistency, it should be there.
  • I would mention the branch "rename" in the intro at the top as well.
    Also: the branch rename has not been done in a typical rename manner, but has added a main branch instead. This is good in that it won't accidentally break CI for any repo now using master, but that makes it all the more important to signal that main should be used from now on.
  • In most cases, the issue number/link goes to the PR, though sometimes to an underlying issue.
    Would it be an idea to use a consistent pattern ?
    Maybe something like [PR link]: description. Fixes [issue link], [issue link] ?

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@GaryJones
Copy link
Contributor Author

@jrfnl PR updated with your suggestions :-)

@GaryJones GaryJones merged commit fad2290 into release/3.0.0 Sep 4, 2023
32 checks passed
@GaryJones GaryJones deleted the release/3.0.0-changelog branch September 4, 2023 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants