Simplify Release Notes section of our PR checklist #5093
Labels
kind/misc
Categorizes issue or PR as a miscellaneuous one.
Comments
dibyom
added a commit
to dibyom/pipeline
that referenced
this issue
Jul 6, 2022
This commit simplifies the release notes section by replacing the existing comment with a default `NONE` release note. In addition it updates the submitter checklist instruction to expect the submitter to update the release note if needed. In addition, it adds two new items to the checklist - 1. to add a kind label using the /kind command and 2. add an `action required:` to the release note if needed. Fixes tektoncd#5093 Signed-off-by: Dibyo Mukherjee <[email protected]>
dibyom
added a commit
to dibyom/pipeline
that referenced
this issue
Jul 6, 2022
This commit simplifies the release notes section by replacing the existing comment with a default `NONE` release note. In addition it updates the submitter checklist instruction to expect the submitter to update the release note if needed. In addition, it adds two new items to the checklist - 1. to add a kind label using the /kind command and 2. add an `action required:` to the release note if needed. Fixes tektoncd#5093 Signed-off-by: Dibyo Mukherjee <[email protected]>
5 tasks
tekton-robot
pushed a commit
that referenced
this issue
Jul 7, 2022
This commit simplifies the release notes section by replacing the existing comment with a default `NONE` release note. In addition it updates the submitter checklist instruction to expect the submitter to update the release note if needed. In addition, it adds two new items to the checklist - 1. to add a kind label using the /kind command and 2. add an `action required:` to the release note if needed. Fixes #5093 Signed-off-by: Dibyo Mukherjee <[email protected]>
dibyom
added a commit
that referenced
this issue
Jul 7, 2022
There was an added space between the backticks and the release-note string See #5093
dibyom
added a commit
that referenced
this issue
Jul 19, 2022
There was an added space between the backticks and the release-note string See #5093
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I find the release notes section of our PR checklist to be confusing - it's long, contains a lot of instructions, the back-ticks have to be followed by the literal string "release-note", the templates within the comment have to be copied outside the comment block, multiple ways of adding the NONE release note etc. In the last two weeks, I have manually fixed the section of at least 3 PRs while reviewing them.
I think we can do better and simplify the experience for most scenarios by:
The text was updated successfully, but these errors were encountered: