Clear release notes and migration script #378
Merged
Conversation
This file contains 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
Signed-off-by: Leandro Lucarella <[email protected]>
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR updates the release notes to clearly separate summary, upgrade instructions, new features, and bug fixes while also outlining cookiecutter-specific details.
- Replaces existing text with structured placeholders for a general summary and upgrade instructions.
- Introduces dedicated sections for cookiecutter template guidance.
- Adds distinct sections for new features and bug fixes with placeholder comments.
Comments suppressed due to low confidence (4)
RELEASE_NOTES.md:9
- Upgrade instructions are currently a placeholder. Ensure to add detailed steps and deprecation notes to guide users through the migration.
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
RELEASE_NOTES.md:25
- The new features section contains a placeholder that should be updated with actual feature details and usage examples.
<!-- Here goes the main new features and examples or instructions on how to use them -->
RELEASE_NOTES.md:29
- Replace this placeholder with specific new feature details for the cookiecutter template to aid user understanding.
<!-- Here new features for cookiecutter specifically -->
RELEASE_NOTES.md:37
- Cookiecutter-specific bug fixes should be explicitly described rather than using a placeholder comment.
<!-- Here bug fixes for cookiecutter specifically -->
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.
No description provided.