Repository navigation
feat: report a bug from Settings, and add issue templates - #17
Merged
Merged
Conversation
Add GitHub issue forms for bug reports and feature requests. The bug form asks for what issue #14's reporter typed out by hand: panel and sing-box versions, system, platform, kernel, service manager and install method. The About card gains "Report a bug", which opens that form with those fields pre-filled through URL parameters named after the form's field ids, and "Copy diagnostics", which copies the same block as text. The panel sends nothing itself: the operator reviews and submits the issue on GitHub as themselves. The hostname, addresses and config are never included. A test reads the template and fails if a field the panel pre-fills is missing from it.
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
Issue #14 was a model report, and its author had to hand-type everything the panel already knows: panel version, package architecture, host, kernel, service backend, core version. This makes that the default.
Issue templates (
.github/ISSUE_TEMPLATE/)bug_report.yml: description, steps to reproduce, panel version, sing-box version, environment, browser, logs. Labels are in English and Chinese. It warns against pasting subscription URLs, passwords, UUIDs or the Clash API secret.feature_request.yml: problem, proposal, alternatives.config.yml: blank issues stay available.Settings → About
id.The panel sends nothing itself. The link opens GitHub in the operator's browser; they review the form and submit it under their own account. No token is involved.
What is never included
The hostname, any address, and anything from
config.json. An issue is public and permanent.Notes
frontend/src/utils/bugReport.ts. A test readsbug_report.ymland fails if a field the panel pre-fills is missing from it.Test plan
bun test(12 new tests for the link builder; full suite passes) andbun run build