docs: add release notes index and template #286
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
Release notes occupy their own top-level section in the documentation TOC. The template for individual release notes is included as a comment at the end of the index.
mr-cal
approved these changes
Nov 27, 2024
mr-cal
reviewed
Nov 27, 2024
|
Re: #286 (comment) I'm hedging against future projects where we might elect not to do this. Should I make it required? |
medubelko
commented
Nov 28, 2024
Elect not to do which part? The semantic versioning? |
Elect to include the optional part about forward-porting. |
I'm happy with what you merged, no need to make it required. |
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.
Release notes occupy their own top-level section in the documentation TOC.
The template for individual release notes is included as a comment at the end of the index. This follows a pattern set by our changelogs. If there's a better way of including copyable templates, please chime in!
tox?CRAFT-3712