docs(breaking-changes): add BREAKING-CHANGES.md#86
Merged
Conversation
Closed
j-g00da
force-pushed
the
j-g00da/breaking-changes
branch
2 times, most recently
from
7566195 to
483ff57
Compare
j-g00da
force-pushed
the
j-g00da/breaking-changes
branch
from
483ff57 to
b7c041d
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds a centralized BREAKING-CHANGES.md to track breaking changes across releases and provide migration guidance.
- Introduces a new
BREAKING-CHANGES.mdlisting all breaking changes for v0.3.0 through v0.0.1. - Includes migration examples for removed features, renamed APIs, new config fields, and MSRV bump.
- Defines reference links to related PRs and structs out summary anchors for easy navigation.
Comments suppressed due to low confidence (4)
BREAKING-CHANGES.md:157
- The reference tag [#48] points to PR #75. Please update the tag or URL to match the correct PR number for consistency.
[#48]: https://github.com/j-g00da/mousefood/pull/75
BREAKING-CHANGES.md:7
- Ensure the anchor
#v030---unreleasedcorrectly matches the autogenerated heading ID for## v0.3.0 - unreleased. You may need to adjust the link target or heading text for proper navigation.
- [v0.3.0](#v030---unreleased) - unreleased
BREAKING-CHANGES.md:23
- [nitpick] Heading style here is inconsistent with other version sections. Consider using
## [v0.3.0](link)like the other versions or adjust the summary link accordingly to maintain consistency.
## v0.3.0 - unreleased
BREAKING-CHANGES.md:77
- [nitpick] The heading could be clearer by emphasizing the addition of a new optional field rather than 'requires providing'. For example: '### Add optional
font_italicfield toEmbeddedBackendConfig'.
### `EmbeddedBackendConfig` now requires providing `font_italic` ([#57])
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resloves #68