From f66d4e325238c8640bb8ca895ace2d503a1da5d5 Mon Sep 17 00:00:00 2001 From: Mohammad Amin jahani Date: Wed, 6 May 2026 15:11:22 +0300 Subject: [PATCH 1/3] chore: add GitHub issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 17 +++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 10 ++++++++++ .github/ISSUE_TEMPLATE/other.md | 10 ++++++++++ .github/ISSUE_TEMPLATE/site_not_working.md | 17 +++++++++++++++++ 5 files changed, 59 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/other.md create mode 100644 .github/ISSUE_TEMPLATE/site_not_working.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..57e4389 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,17 @@ +--- +name: Bug report +about: Something is broken in the proxy +title: 'bug: ' +labels: bug +--- + +**Version / OS / Python:** + +**What happened:** + +**Steps to reproduce:** + +**DEBUG log excerpt (redact `auth_key` and `script_id`):** + +``` +``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..d36bb13 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Setup help and general questions + url: https://github.com/denuitt1/mhr-cfw#readme + about: Read the README first — it covers setup, AUTH_KEY / WORKER_URL wiring, and `--scan`. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..eb1e7a0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,10 @@ +--- +name: Feature request +about: Suggest an improvement +title: 'feat: ' +labels: enhancement +--- + +**Problem:** + +**Proposal:** diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md new file mode 100644 index 0000000..abf1fb2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.md @@ -0,0 +1,10 @@ +--- +name: Other +about: Anything that doesn't fit the templates above +title: '' +labels: '' +--- + +**What's this about:** + +**Details:** diff --git a/.github/ISSUE_TEMPLATE/site_not_working.md b/.github/ISSUE_TEMPLATE/site_not_working.md new file mode 100644 index 0000000..99680f7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/site_not_working.md @@ -0,0 +1,17 @@ +--- +name: Site not working +about: A specific site fails through the proxy (other sites are fine) +title: 'site: ' +labels: site-issue +--- + +**URL:** + +**Works without the proxy:** yes / no + +**What you see (error, blank page, broken assets, etc.):** + +**DEBUG log excerpt for the failing request (redacted):** + +``` +``` From 4ad07aebd28e8ffc0f90d456003bae7f65c3bd03 Mon Sep 17 00:00:00 2001 From: Mohammad Amin jahani Date: Wed, 6 May 2026 15:21:59 +0300 Subject: [PATCH 2/3] chore: split version / OS / Python prompts in bug report --- .github/ISSUE_TEMPLATE/bug_report.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 57e4389..80734c1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -5,7 +5,11 @@ title: 'bug: ' labels: bug --- -**Version / OS / Python:** +**Version:** + +**OS:** + +**Python version:** **What happened:** From 98c508af98c3180635941ebcab3c825f1a97bf06 Mon Sep 17 00:00:00 2001 From: Mohammad Amin jahani Date: Wed, 6 May 2026 15:22:38 +0300 Subject: [PATCH 3/3] chore: convert bug report to issue form with required inputs --- .github/ISSUE_TEMPLATE/bug_report.md | 21 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 46 +++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 21 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 80734c1..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Bug report -about: Something is broken in the proxy -title: 'bug: ' -labels: bug ---- - -**Version:** - -**OS:** - -**Python version:** - -**What happened:** - -**Steps to reproduce:** - -**DEBUG log excerpt (redact `auth_key` and `script_id`):** - -``` -``` diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..688d9da --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,46 @@ +name: Bug report +description: Something is broken in the proxy +title: "bug: " +labels: ["bug"] +body: + - type: input + id: version + attributes: + label: Version + placeholder: "e.g. 1.4.2 or commit abc1234" + validations: + required: true + + - type: input + id: os + attributes: + label: OS + placeholder: "e.g. Windows 11, macOS 14, Ubuntu 22.04" + validations: + required: true + + - type: input + id: python + attributes: + label: Python version + placeholder: "e.g. 3.11.7" + validations: + required: true + + - type: textarea + id: what + attributes: + label: What happened + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + + - type: textarea + id: logs + attributes: + label: DEBUG log excerpt (redact `auth_key` and `script_id`) + render: text