Files
3x-ui/.github/ISSUE_TEMPLATE/bug_report.yaml
T
Sanaei 8cec47a8a5 fix(ci): resync the bot prompts with the repo and close the gaps an audit found
The three prompts still enforced the comment ban CLAUDE.md replaced with
the 2-line cap on Aug 1 (1ff90c5b), so the review bot would flag every
legitimate short comment; frontend/CLAUDE.md and CONTRIBUTING.md carried
the same stale rule. The PR reviewer's recipe for reading a post-change
file (headRefOid + pr diff) was unfulfillable with its allowlist - it now
fetches refs/pull/N/head and reads blobs via git show, object-only, no
checkout. Conventions the reviewer checks now include the unchecked docs
openapi.json copy step, the docs/lib/xray third link implementation, the
both-ways route contract, and the i18n dead-key half of the rule.

Also: drop the SUBPROCESS_ENV_SCRUB=0 override on the two untrusted-input
jobs (the mention job proves gh works scrubbed); teach the triage prompt
the issue forms (pre-applied labels, required fields, no re-asking); add
a security-report exception plus SECURITY.md so vulnerabilities are not
confirmed publicly; add a clarification follow-up job so a reporter's
reply to "clarification needed" is actually processed; review PRs again
on ready_for_review and skip drafts; stamp the reviewed head SHA so
force-pushes visibly date a review; scope gh issue/pr edit to label and
title flags; per-job concurrency; comment guards now match the actual
bot login after the run started; artifact names survive re-runs; the
mention prompt's repo map and env-var facts corrected (XUI_PORT,
XUI_TUNNEL_HEALTH_*, distro env files, memory.high, encrypt-tokens).
The bug and feature forms also referenced a "needs triage" label that
does not exist in the repo and was silently never applied - dropped.
2026-08-17 02:41:21 +02:00

168 lines
4.6 KiB
YAML

name: Bug report
description: Report something that is broken or behaving unexpectedly
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to file a bug. A complete report helps us
reproduce and fix it quickly. Please **search [existing issues](../issues?q=is%3Aissue)**
before opening a new one — duplicates will be closed.
- type: textarea
id: what-happened
attributes:
label: Describe the bug
description: A clear and concise description of what went wrong.
placeholder: When I … the panel does … but I expected it to …
validations:
required: true
- type: textarea
id: how-repeat-problem
attributes:
label: How to reproduce the problem
description: Numbered steps starting from a clean state. The clearer the steps, the faster the fix.
placeholder: |
1. Open the `Inbounds` page
2. Create a new VLESS inbound with …
3. Click `Save`
4. Observe …
validations:
required: true
- type: textarea
id: expected-action
attributes:
label: Expected behavior
placeholder: I expected the panel to …
validations:
required: false
- type: textarea
id: received-action
attributes:
label: Actual behavior
placeholder: Instead, the panel …
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant logs
description: |
Panel logs (`journalctl -u x-ui -n 200`) and/or the browser DevTools
console output. **Redact** tokens, real domains, IPs, and client UUIDs.
render: shell
validations:
required: false
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: |
Drag images directly into this field. Redact any sensitive data.
Images cannot be searched or machine-read — always paste the exact
error text or log lines as text in the fields above as well.
validations:
required: false
- type: input
id: xui-version
attributes:
label: 3x-ui version
description: Shown at the top of the panel sidebar.
placeholder: 3.1.0
validations:
required: true
- type: input
id: xray-version
attributes:
label: Xray-core version
description: Visible on the `Xray Settings` page.
placeholder: 25.x.x
validations:
required: false
- type: dropdown
id: install-method
attributes:
label: How did you install 3x-ui?
options:
- install.sh script
- Docker / Docker Compose
- Manual build from source
- Other (please describe in the bug body)
validations:
required: true
- type: input
id: os
attributes:
label: Operating system
description: Distribution and version.
placeholder: Ubuntu 24.04 / Debian 12 / CentOS Stream 9 …
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which parts of the panel are affected?
multiple: true
options:
- Frontend (UI / panel pages)
- Backend (API endpoints, login, settings)
- Xray config generation
- Subscription (share links / Clash / JSON)
- Statistics / traffic counters
- Database / migrations
- Install / upgrade script
- Docker image
- Multi-node (sub-nodes)
- Telegram bot
- Other
validations:
required: false
- type: input
id: browser
attributes:
label: Browser (only if it is a UI bug)
placeholder: Chrome 132 / Firefox 134 / Safari 18 / mobile Chrome …
validations:
required: false
- type: dropdown
id: reverse-proxy
attributes:
label: Is the panel behind a reverse proxy or CDN?
options:
- "No — direct access"
- "Yes — Nginx"
- "Yes — Caddy"
- "Yes — Cloudflare (proxied DNS)"
- "Yes — Cloudflare Tunnel"
- "Yes — other"
validations:
required: false
- type: checkboxes
id: checklist
attributes:
label: Before submitting
options:
- label: I searched [existing issues](../issues?q=is%3Aissue) and this bug has not been reported.
required: true
- label: I am running the latest released version of 3x-ui (or have verified the bug still exists on it).
required: true
- label: This bug report is written in English.
required: true
- label: I have redacted any sensitive data (tokens, real domains, client UUIDs).
required: true