Add enforced bug-report and feature-request issue forms#180
Merged
Conversation
Repo had PR templates but no issue templates, so low-quality "it doesn't work" reports could not be gated. Add a YAML issue FORM with required fields (firmware version via TESTFX3, provenance, USB enumeration state, repro steps, logs, recoverability) so submission is blocked until reporters provide what triage actually needs. Also disable blank issues and add contact links routing questions and R828D/VHF requests away from the bug tracker. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017HPZJJc4fvRmVhFCVdKDh6
Gate enhancement requests the same way as bug reports: required fields for problem/motivation, concrete proposal, affected firmware area, recoverability impact (Principle 2), alternatives (esp. host-side), and compatibility/version impact. Pushes scope-creep, host-side work, and out-of-scope VHF/R828D requests away before triage. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017HPZJJc4fvRmVhFCVdKDh6
Flat "VHF is out of scope" became a ceiling rather than a gate. Reword both forms and the contact link so simple bounded R828D control (init, standby) can be proposed with a good argument, while full VHF tuning, gain-stage, and channel-filter control remain refused and host-side. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017HPZJJc4fvRmVhFCVdKDh6
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
2 participants
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 repo had detailed PR templates but no issue templates, so anyone could file a one-line "it doesn't work." This adds two GitHub issue forms (not markdown templates) — forms enforce required fields, so a non-compliant report is blocked at submission time rather than triaged and bounced.
New files:
.github/ISSUE_TEMPLATE/bug_report.yml— enforced bug form.github/ISSUE_TEMPLATE/feature_request.yml— enforced enhancement form.github/ISSUE_TEMPLATE/config.yml—blank_issues_enabled: false+ contact links routing questions and VHF/R828D requests away from the trackerWhat the forms require
Bug report (all required): pre-flight checkboxes (dupe search, deterministic repro, confirmed firmware-not-host/RF/power/cable, not a VHF request); firmware version as reported by the device via
TESTFX3(not the repo tag); firmware provenance + commit/tag +arm-none-eabi-gccversion; USB enumeration state (04b4:00f3/04b4:00f1/ gone) fromlsusb; host environment; numbered repro steps; expected vs actual (split); pasted logs (render: text); recoverability (power cycle required?); and isolation steps already tried.Feature request (all required): pre-flight (dupe search, can't-be-done-host-side, not VHF, read the docs); problem/motivation; concrete proposal; primary firmware area; recoverability impact (Principle 2); alternatives considered (esp. host-side); compatibility/version impact.
Every field is grounded in real repo facts (
TESTFX3/protocol.h, firmware v2.6, the04b4:00f1/00f3IDs, HF-only Limitations, recoverability Principle 2 fromdocs/vendor-protocol-plan.md), per the CLAUDE.md "no speculation" policy.Validation
yaml.safe_load) — verified locally.…/issues/new/chooseshows "Bug report" and "Feature request", "Open a blank issue" is gone, required-blank submission is rejected by GitHub, and contact links render under the chooser.Regression
.github/ISSUE_TEMPLATE/files added — no source, build, test, workflow, or PR-template changes. Firmware artifact unchanged.🤖 Generated with Claude Code
https://claude.ai/code/session_017HPZJJc4fvRmVhFCVdKDh6
Generated by Claude Code