docs: clarify required pull-request template sections and mark screenshots optional - #6
Merged
Conversation
…shots optional State in the template that Summary, Context, Validation, and Impact and rollback are required, must appear in that order, and must each hold real content — repository-policy fails the pull request when a section is left empty, and an unedited comment counts as empty. Keep the placeholders as comments so the fill-required gate is unchanged; mark Screenshots optional. Refs CUS-128. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.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
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
Clarify the shared pull-request template so the four required sections (
Summary,Context,Validation,Impact and rollback) are unmistakably required, ordered, and must be non-empty, and markScreenshotsoptional. Placeholders stay as HTML comments, so the fill-required behaviour ofrepository-policyis unchanged — this only sharpens the guidance.Implements Option A (documentation-only variant) of CUS-128.
Context
repository-policyfails a PR whose required sections are empty, and it strips HTML comments before measuring content — so a PR opened from this template unmodified fails, because every section was only a comment. The previous wording never said the sections were required, ordered, or that an unedited comment counts as empty, so agents and humans opened PRs from it and were surprised by the failure. This adds a short intro note stating the rule and tightens each per-section prompt, without shipping default content (which would let meaningless bodies pass and defeat the gate).Validation
bash -n repository-policy/validate.shandbash repository-policy/validate.sh --self-testare unaffected — thecijob does not cover the template file, and this change does not touchvalidate.sh.required[1..4].docs/branch, conventional title, and this filled four-section body.Impact and rollback
Documentation only. Changes the default PR template text presented across org repositories; no change to
validate.sh, workflows, or rulesets, so no change to what actually passes or fails. Revert this PR to roll back.