From 461e30ee255de882e40713c17f7b972285b94a11 Mon Sep 17 00:00:00 2001 From: Brandon Pereira Date: Mon, 28 Sep 2026 12:35:27 -0600 Subject: [PATCH] docs(github): add debug-info ask and Needs Feedback issue flow Improve the issue intake in two ways: - Bug report now strongly requests the Help -> Copy debug info block for UI bugs, so version/deployment/browser/session context arrives with the report. - New issues start as `Needs Feedback` (auto-applied by the templates) and are only ready to be PR'd once a maintainer swaps that for `Accepting PR`. Adds a feature-request template, disables blank issues so every issue picks up the label, and documents the issue -> PR flow in CONTRIBUTING.md. --- .github/ISSUE_TEMPLATE/bug-report.md | 16 ++++++++++++- .github/ISSUE_TEMPLATE/config.yml | 11 +++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 29 +++++++++++++++++++++++ CONTRIBUTING.md | 20 ++++++++++++++++ 4 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml 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 index 975e6ba0f5..c8296318e6 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -2,7 +2,7 @@ name: Bug report about: Something in HyperDX is broken or behaving unexpectedly title: '' -labels: bug +labels: bug, Needs Feedback --- **What happened?** @@ -30,6 +30,20 @@ The UI (which page, and which browser), the API, the OpenTelemetry collector, or the CLI. A screenshot or a short video helps a lot for UI bugs. --> +**Debug info** + + + +``` +(paste Help → Copy debug info here) +``` + **Logs** + +**What would you like to see?** + + + +**Alternatives you've considered** + + + +**Anything else?** + + + +--- + +New issues start as `Needs Feedback` so we can discuss scope before anyone +writes code. Once a maintainer swaps that for `Accepting PR`, the issue is ready +to be picked up — see +[CONTRIBUTING.md](https://github.com/hyperdxio/hyperdx/blob/main/CONTRIBUTING.md#from-issue-to-pull-request). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6741f9658f..e22f119268 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,6 +57,26 @@ you merge it.** That PR needs an approval rather than a green CI run — GitHub does not run workflows on PRs the bot creates. Merge them one at a time; two open at once will conflict on the same sorted list. +## From issue to pull request + +New bug reports and feature requests open with a `Needs Feedback` label (the +issue templates apply it automatically). That label means the issue is still +being discussed — the scope, the approach, or whether we want the change at all +isn't settled yet. **Please don't start a PR against a `Needs Feedback` +issue**; the discussion often changes what the fix should be, and code written +too early tends to get thrown away. + +Once a maintainer is happy with the direction, they swap `Needs Feedback` for +`Accepting PR`. That's the green light: the issue is understood and ready for +someone to pick up. Comment to claim it so two people don't duplicate work, then +open your PR and reference the issue (e.g. `Closes #123`). + +If an issue you care about is stuck in `Needs Feedback`, add the missing detail +(a clear repro, the debug info from Help → Copy debug info, your use case) or +ask on the issue — that's usually what unblocks it. This is a convention, not a +hard gate: it keeps effort pointed at changes we've agreed on, on top of the +vouching trust check above. + ## Architecture Overview ![architecture](./.github/images/architecture.png)