Skip to content

docs: added small manual CHANGELOG.md#56

Merged
JoshuaKGoldberg merged 1 commit intomainfrom
manual-changelog
Jul 17, 2023
Merged

docs: added small manual CHANGELOG.md#56
JoshuaKGoldberg merged 1 commit intomainfrom
manual-changelog

Conversation

@JoshuaKGoldberg
Copy link
Copy Markdown
Collaborator

#55 will add more infrastructure to auto-generate a nicer file. In the meantime, this adds the last few months of changes (since I started working on this repo).

Fixes #48.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

cc @yvele @Haroenv @G-Rath from #36 and #48 - I think this answers what you suggested should be answered. Please let me know if not (here or in a new issue, whatever's easier for you) - I can always add more!

Copy link
Copy Markdown

@yvele yvele Jul 17, 2023

Choose a reason for hiding this comment

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

So there should be not breaking changes in 1.0.0 ? So maybe could you add a "Although a major version bump, there should no breaking change".

See https://semver.org/#spec-item-8

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yup! Good clarification, thanks - the intent is to signal that the API is stable, not that it's changing.

@JoshuaKGoldberg JoshuaKGoldberg merged commit 26c8235 into main Jul 17, 2023
@JoshuaKGoldberg JoshuaKGoldberg deleted the manual-changelog branch July 17, 2023 16:36
JoshuaKGoldberg added a commit that referenced this pull request Jul 17, 2023
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 this pull request may close these issues.

Add a changelog

2 participants