From e1ec1805ae0269864d3dd6d778db802b27f469b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Efe=20G=C3=B6kdemir?= Date: Mon, 5 Oct 2026 02:41:12 +0300 Subject: [PATCH] docs: add privacy-safe issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 26 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 9 +++++--- .github/ISSUE_TEMPLATE/feature_request.md | 17 +++++++++++++++ 3 files changed, 49 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..423a76e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug report +about: Report a reproducible issue in this tool +title: "[Bug]: " +--- + +## Environment + +- Tool version: +- Node.js version: +- Operating system: +- CLI, GitHub Action, or library usage: + +## Description + +## Steps to reproduce + +1. +2. +3. + +## Expected and actual behaviour + +## Minimal sanitised fixture or output + +Use synthetic configuration and remove Shopify credentials, merchant data, private repository URLs, access tokens, and secrets. Do not report suspected security vulnerabilities here; use the private reporting link in the repository's issue menu. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 61733cb..42e5932 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,8 @@ blank_issues_enabled: false contact_links: - - name: Security reports - url: https://github.com/RexCode-Digital/shopify-upgrade-guard/blob/main/SECURITY.md - about: Please report suspected vulnerabilities privately instead of opening a public issue. + - name: Report a security vulnerability privately + url: https://github.com/RexCode-Digital/shopify-upgrade-guard/security/advisories/new + about: Do not report suspected vulnerabilities or include secrets in a public issue. + - name: Support and usage questions + url: https://github.com/RexCode-Digital/shopify-upgrade-guard/blob/main/SUPPORT.md + about: Review the support guide before opening a usage question. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2f84a57 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest a focused improvement to the tool +title: "[Feature]: " +--- + +## Problem or use case + +## Proposed behaviour + +## Shopify surface or documentation evidence (if applicable) + +Link current official Shopify documentation where the request depends on Shopify semantics. + +## Alternatives considered + +Do not include credentials, merchant/customer data, private source, or production configuration.