docs: add issue forms for bugs, features, and docs - #96
Merged
Conversation
Three forms, each applying the label it maps to, aimed at someone who does not know the codebase: a bug report asks for the version and whether the site is Cloud, gateway-routed, or Data Center, since a bug is usually specific to one; a feature request leads with the task rather than the flag; a documentation report distinguishes wrong from unclear from missing, and asks a Confluence correction for the observation behind it, because docs/confluence/ entries carry their provenance and one we cannot reproduce starts over. Blank issues stay enabled, with a comment in config.yml saying why. Every issue in this repo so far is a long-form writeup with its own structure, and a form would be strictly worse for that -- these are a floor for a stranger, not a shape every issue has to fit. The one contact link routes a vulnerability to the private advisory flow, which is what SECURITY.md promises. No Discussions link: it is disabled.
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.
Adds three YAML issue forms plus a
config.yml, each form applying the label it maps to (bug,enhancement,documentation— all already in use here).Blank issues stay enabled, and
config.ymlcarries a comment saying why. All 25 issues in this repo so far are long-form writeups with their own structure — evidence, cause, decided design, tables, code refs — and a form would be strictly worse for that. These are a floor for someone who does not know the codebase, not a shape every issue has to fit.What each form asks for that a generic template would not:
api.atlassian.com-gateway vs. Data Center, since a bug is usually specific to one and that distinction already shapes the client. Optional field for the markdown file, noting that frontmatter matters becausepage_id/space/parentchange what the command does. A required checkbox to confirm no token got pasted.docs/confluence/: those entries carry provenance by convention, so a correction about Confluence behavior needs the observation attached, or the next person establishes it from scratch.The single contact link routes a vulnerability to the private advisory flow, which is what
SECURITY.mdpromises.