chore: add PR description template - #722
Open
Iheanacho-ai wants to merge 1 commit into
Open
Conversation
Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Adds a PR description template with a Testing section that prompts contributors for verification details.
Why
The new contribution standards expect every PR to say who verified a change and what wasn't covered by the page itself, but nothing currently prompts for that. This gives contributors a starting shape without forcing a rigid format.
Change
.github/PULL_REQUEST_TEMPLATE.mdTesting
Confirmed the rendered markdown strips both HTML comment blocks and shows only the section headers — pasted the raw template content into a blank PR description box and previewed it.
Read through the committed file to confirm the structure and content match what was agreed.
Pull request template auto-fill only works once a template is on the repository's default branch, so that part can't be verified until this merges. Will open a disposable PR right after merging to confirm the description box pre-fills untouched, then close it without merging.