Add release-note section in PR template #1574
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
Problem: Writing release notes at release time takes a long time and it's not easy to do if you don't have as much context as the submitter or simply too much time has passed. Solution: Add a release notes section to be filled out when opening a PR. This way at release time we can just grab all the descriptions and speed up the process.
github-actions
bot
added
the
documentation
|
Just so I understand, there's no automatic process as of right now that uses the new note in the generated release notes, right? When writing our curated notes, it's still manual, but this just gives us a note to reference? |
|
yep the generated notes are still the same (and we should probably still keep them the same?), this would be for the curated notes that is still a manual process (for now) |
sjberman
approved these changes
Feb 14, 2024
bjee19
approved these changes
Feb 14, 2024
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.
Proposed changes
Problem: Writing release notes at release time takes a long time and it's not easy to do if you don't have as much context as the submitter or simply too much time has passed.
Solution: Add a release notes section to be filled out when opening a PR. This way at release time we can just grab all the descriptions and speed up the process.
Closes #1034
Checklist
Before creating a PR, run through this checklist and mark each as complete.