Repository navigation
chore: enforce concise PR descriptions - #563
Merged
Merged
Conversation
Signed-off-by: Jason <wch19961116@gmail.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
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.
TLDR
Require NoKV PRs to explain the problem, impact, example, solution, benefit, and tradeoffs in a consistent short format.
Problem
The template and agent guidance did not enforce the preferred description format. This is CI policy maintenance, an allowed exception to the linked-issue requirement.
Consequences
Descriptions can list changed files without explaining the resulting behavior, leaving reviewers to reconstruct the intent.
Example
Before: a Summary and long checklist could omit the user impact. After: missing or empty required sections fail the description check, including after title or body edits.
Solution
Align the template, contributor guide, and agent instructions, and validate live PR metadata with the protected base policy. Use the same validator locally.
Gain
Authors and reviewers share one documented structure and an automated check for incomplete descriptions.
Tradeoffs
The check validates structure and filled-in content; clarity and factual claims still need review. Activate the new required checks after this PR merges so the protected workflow is available.
Validation