From 1e3526fada5c15fe1faa956b8c27c0a52f506735 Mon Sep 17 00:00:00 2001 From: krystal <56278409+theekrystallee@users.noreply.github.com> Date: Fri, 15 May 2026 17:01:45 -0700 Subject: [PATCH] chore: add QA feedback issue template and tags for docs revamp Signed-off-by: krystal <56278409+theekrystallee@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/qa-feedback.yml | 60 ++++++++++++++++++++++++++ revamp/setup-qa-labels.sh | 38 ++++++++++++++++ 2 files changed, 98 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/qa-feedback.yml create mode 100644 revamp/setup-qa-labels.sh diff --git a/.github/ISSUE_TEMPLATE/qa-feedback.yml b/.github/ISSUE_TEMPLATE/qa-feedback.yml new file mode 100644 index 00000000..ac5469d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/qa-feedback.yml @@ -0,0 +1,60 @@ +name: QA Feedback (Docs Revamp) +description: Report a problem found during the May 14–20 docs revamp QA testing window +title: "[QA] " +labels: + - "qa/may-2026" +body: + - type: markdown + attributes: + value: | + Thanks for helping QA the docs revamp! One issue per problem, please — easier to track and close out. + + - type: dropdown + id: tab + attributes: + label: Which tab? + description: The tab where you found the issue. This determines who triages it. + options: + - Learn + - EVM Developers + - Native SDKs + - Operators + - Reference + - Solutions + - Support + validations: + required: true + + - type: input + id: page-url + attributes: + label: Page URL or path + description: The dev-branch URL or file path (e.g. `evm/quickstart/deploy-with-hardhat.mdx`) + placeholder: "evm/quickstart/deploy-with-hardhat.mdx" + validations: + required: true + + - type: textarea + id: problem + attributes: + label: What's the problem? + description: Short description of what's wrong. Include expected vs actual behavior if relevant (e.g. for code samples that don't run). + placeholder: | + e.g. The `npm install` command on this page errors out with "package not found" because the package name was renamed. + validations: + required: true + + - type: textarea + id: suggestion + attributes: + label: Suggested fix (optional) + description: If you know how to fix it, tell us. Otherwise leave blank. + validations: + required: false + + - type: markdown + attributes: + value: | + --- + + **Reminder:** after submitting, add the `tab/` label matching the tab you picked above (e.g. `tab/evm`). If you have permission to add a priority label (`P1`/`P2`/`P3`), do that too. \ No newline at end of file diff --git a/revamp/setup-qa-labels.sh b/revamp/setup-qa-labels.sh new file mode 100644 index 00000000..6d821317 --- /dev/null +++ b/revamp/setup-qa-labels.sh @@ -0,0 +1,38 @@ +#!/bin/bash +# ============================================================================ +# Hedera Docs QA Labels Setup +# ============================================================================ +# Creates the minimal set of GitHub labels for the docs revamp QA campaign. +# +# Labels: +# - 7 tab labels (one per documentation tab) for routing to working-group pairs +# - 1 campaign label (qa/may-2026) to distinguish QA feedback from regular issues +# +# Priority labels (P1, P3) already exist in the repo and are reused as-is. +# Type labels (broken-link, outdated-code, etc.) intentionally omitted — +# the issue title and body convey this information without needing taxonomy. +# +# Usage: +# ./revamp/setup-qa-labels.sh +# +# Requires: gh CLI authenticated against the hedera-docs repo +# Safe to re-run: --force updates existing labels rather than erroring +# ============================================================================ + +set -e + +echo "Creating tab labels..." +gh label create "tab/learn" --color "0E8A16" --description "Issue in the Learn tab" --force +gh label create "tab/evm" --color "1D76DB" --description "Issue in the EVM Developers tab" --force +gh label create "tab/native" --color "5319E7" --description "Issue in the Native SDKs tab" --force +gh label create "tab/operators" --color "B60205" --description "Issue in the Operators tab" --force +gh label create "tab/reference" --color "FBCA04" --description "Issue in the Reference tab" --force +gh label create "tab/solutions" --color "D93F0B" --description "Issue in the Solutions tab" --force +gh label create "tab/support" --color "5DADE2" --description "Issue in the Support tab" --force + +echo "Creating QA campaign label..." +gh label create "qa/may-2026" --color "0E8A16" --description "Filed during May 15–20 QA testing window" --force + +echo "" +echo "Done. 8 labels created/updated." +echo "Testers should apply: 1 tab label + qa/may-2026 (+ optional priority)." \ No newline at end of file