docs: Add pull request template#58
Merged
Merged
Conversation
Adds .github/PULL_REQUEST_TEMPLATE.md so GitHub prefills new PR descriptions with a four-section skeleton: Summary, Validation, Linked issues, Risk/rollout notes. Section guidance lives in HTML comments — they prompt the author without rendering in the final PR body, so small PRs aren't buried in headers. The Validation section explicitly asks for "what you actually ran and saw, not what you intended to run". Aimed at the failure mode where a PR claims test coverage that wasn't actually executed. Refs #43
Jam-Cai
changed the title
Jam-Cai
changed the title
Collaborator
Author
|
ykw its an md file, YOLO |
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
1 participant
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.
Summary
Adds
.github/PULL_REQUEST_TEMPLATE.mdso GitHub prefills new PR descriptions with a four-section skeleton: Summary, Validation, Linked issues, Risk/rollout notes.Validation
Linked issues
Refs #43
Risk / rollout notes