chore: add issue templates so reporters are not handed a blank box - #173
Merged
Conversation
Every repo here has CONTRIBUTING.md, SECURITY.md and a PR template, but no issue template, so a first-time reporter got an empty textarea and had to guess what would be useful. That costs a round trip on almost every report. Adds GitHub issue forms: a bug report that asks for what happened, what was expected, the input, and the version; an idea form that says out loud that a bad-fit suggestion is fine; and a config that routes 'is this a bug or did I misread the spec' to Discussions and vulnerabilities to SECURITY.md instead of a public issue. Descriptions are folded block scalars rather than plain scalars, because prose containing a colon and a space is ambiguous YAML and the form silently fails to render. Signed-off-by: Chelsea Kelly-Reif (she/her) <ckellyreif@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
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.
Why
This repo already has
CONTRIBUTING.md,SECURITY.mdand (mostly) a PR template. It had no issue template, so a first-time reporter opened an empty textarea and had to guess what would be useful. That costs a round trip on nearly every report, and for a validator it costs the most, because a useful report needs the input, the version, and expected-vs-actual.What
GitHub issue forms:
jsonfor payloads,textfor feeds) and asks the reporter to reduce the case first.config.yml— routes "is this a bug or did I misread the spec?" to Discussions, and vulnerabilities toSECURITY.mdrather than a public issue. Blank issues stay enabled, so nobody is forced through a form.One implementation note
Field descriptions are folded block scalars (
>-), not plain scalars. Prose containing a colon followed by a space is ambiguous YAML, and a form that fails to parse does not error visibly, it just silently stops rendering. The first draft had exactly that bug in thectdl-validatepayload hint. All 28 generated files now parse underyaml.safe_load.