chore: improve pull request template to include kind lines in comments instead of quote #1538
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
…s instead of quote Signed-off-by: Cheng Fang <cfang@redhat.com>
svghadi
approved these changes
Sep 13, 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.
What type of PR is this?
/kind chore
What does this PR do / why we need it:
Current PR template uses quote (>) to list all kind values, while it probably intend to use comments so submitters can choose the right PR kind by uncommenting a certain line.
I found the current template a bit confusing. I've seen some PR descriptions still contain all kind lines, or having the selecting kind line as quote.
With the fix in this PR, submitters just need to uncomment the right kind line, leave the rest as is, and the rendered description will only display the selected kind line, while keeping the other kind lines as hidden comments. Submitters can also choose to delete the 2 instruction lines and unused kind lines.
Have you updated the necessary documentation?
Which issue(s) this PR fixes:
Fixes #?
How to test changes / Special notes to the reviewer: