Convert issue forms to markdown templates - #26
Open
mcdigman wants to merge 1 commit into
Open
Conversation
The YAML issue forms rendered as a fixed form with no editable body, which is more rigid than this project needs. Markdown templates prefill the same guidance as an editable body, keeping the chooser entries, title prefixes, and auto-applied labels. Also drops the Questions and Documentation contact links: a contact link navigates away from issue creation, so pointing one at the docs site meant "Documentation" opened the docs rather than a docs issue. Security keeps its link, where redirecting away from a public issue is the intent. Two corrections carried in: the adapter template no longer uses vulture as its example, since vulture already ships an adapter, and the corpus template spells out the SPDX allowlist inline instead of hiding it in a dropdown. Co-Authored-By: Claude Opus 5 <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
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
The YAML issue forms added in #24 render as a fixed form with no editable
body. That is more rigid than this project needs — a reporter cannot restructure
the report, drop an irrelevant section, or paste a shape the form did not
anticipate. This converts all four to classic Markdown templates, which prefill
the same guidance as an editable issue body.
What changed
.github/ISSUE_TEMPLATE/0{1..4}_*.yml→.md, withname/about/title/labelsfrontmatter. Chooser entries,[bug]-style title prefixes, and auto-applied labels are unchanged; the forms' guidance survives as HTML comments, which do not render in the posted issue. Dropdowns became "delete all but one" lists.config.yml: dropped the Questions and help and Documentation contact links. A contact link navigates away from issue creation, so a "Documentation" entry opened the docs site rather than starting a docs issue — not what a chooser entry implies. Security vulnerability stays, since redirecting away from a public issue is exactly its intent.vultureas its example detector name (vulture already ships an adapter inliveness_primer/tools/vulture.py), and the corpus template spells out the SPDX allowlist inline instead of hiding it in a dropdown.Verification
uv run prek run --all-filespasses. Frontmatter on all four templates parsesas YAML with the expected keys:
All referenced labels (
bug,adapter,enhancement,corpus) exist on therepository. No file outside
.github/ISSUE_TEMPLATE/references the old.ymlpaths.
Checklist
uv run prek run --all-filespasses locally.CHANGELOG.mdentry skipped — repository metadata only, no packaged behavior change.Tests, docstrings, and schema/corpus/explorer items do not apply: no Python
changed.
AI assistance
Claude Code performed the conversion and drafted the template prose; the
decision to move off issue forms and the contact-link removals are the
maintainer's, and the output was reviewed before commit.
Notes for the reviewer
Trade-off worth confirming: Markdown templates cannot require fields or vary
labels by answer, so version and reproduction details are now advisory. Given
that only
descriptionwas actually required in the forms, this gives uplittle enforcement in practice.
🤖 Generated with Claude Code