docs: add a pull request template - #97
Merged
Merged
Conversation
One unconditional checkbox -- make check -- and everything else under "if it applies", so a docs typo does not have to answer for the converter. The guidance is in HTML comments, which leaves a clean prose body for an author who deletes nothing; this prefills on every human PR, so it had to be cheap to ignore. The Confluence question is a comment rather than a checkbox, because "which flavor did you exercise this against" wants an answer and a checkbox invites ticking it instead. The conditional items are the traps CI reports badly or not at all: regenerating goldens without reading the diff, a --json change that misses the schema, and a new subcommand in the command enum with no if/then branch, which is how a conformance test goes green over a completely unvalidated command.
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.
Adds
.github/PULL_REQUEST_TEMPLATE.md. Sections: what this does,Fixes #, verification, and an "if it applies" list.Three choices worth reviewing. The guidance is all in HTML comments, so an author who deletes nothing still gets a clean prose body — this prefills on every human PR including yours, so it had to be cheap to ignore, and the opening comment says outright to delete what does not apply. There is exactly one unconditional checkbox,
make check; everything else is conditional, so a docs typo does not have to answer for the converter. And the Confluence question is a comment rather than a checkbox, because "which flavor did you exercise this against — Cloud, gateway-routed, or Data Center" wants a sentence, whereas a checkbox invites ticking it without doing it; it also repeats thebody.storagewarning fromdocs/confluence/.The conditional items are deliberately the traps that CI reports badly or not at all, rather than a generic checklist: regenerating goldens without actually reading the diff, a
--jsonchange that missesschema/json-output/v1.json, and a new subcommand landing in the schemacommandenum with noif/thenbranch — which is how a conformance test goes green over a command that is completely unvalidated. An outside contributor would not know that one and the failure would not explain itself.Note that Dependabot ignores PR templates and writes its own body, so the weekly dependency PRs are unaffected.
This is also the last of the community health files GitHub looks for:
LICENSE,CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md, issue forms, and now this.