docs(release): add tips for referencing the examples repository
#2669
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
We often forget to mention changes in the `examples` repository in the release notes. So, update the `release-drafter` template to guide the writers.
csouchet
approved these changes
May 5, 2023
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.
We often forget to mention changes in the
examplesrepository in the release notes. So, update therelease-draftertemplate to guide the writers.Notes
This occured in the 0.34.0 release notes: https://github.com/process-analytics/bpmn-visualization-examples/releases/tag/v0.34.0
In this case, we try to make up for the omission in the following notes but it requires extra work not to forget.
These tips will result in better documentation and less work for the maintainers.