Repository navigation
docs(github): add debug-info ask and Needs Feedback issue flow #3239
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -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** | ||||||||||||||||
|
|
||||||||||||||||
| <!-- | ||||||||||||||||
| For UI bugs, please include this — it saves a lot of back-and-forth. Open the | ||||||||||||||||
| Help menu (bottom-left of the app) and click "Copy debug info", then paste the | ||||||||||||||||
| block below. It captures versions, deployment mode, browser, and session id; no | ||||||||||||||||
| API keys or query params are included. Skip it if you're only hitting the | ||||||||||||||||
| collector or CLI (write N/A). | ||||||||||||||||
|
Comment on lines
+38
to
+40
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time! |
||||||||||||||||
| --> | ||||||||||||||||
|
|
||||||||||||||||
| ``` | ||||||||||||||||
| (paste Help → Copy debug info here) | ||||||||||||||||
| ``` | ||||||||||||||||
|
|
||||||||||||||||
| **Logs** | ||||||||||||||||
|
|
||||||||||||||||
| <!-- | ||||||||||||||||
|
|
||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,11 @@ | ||||||||||||
| # Blank issues are disabled so every issue starts from a template and picks up | ||||||||||||
| # the `Needs Feedback` label. Use the templates or the links below. | ||||||||||||
|
Comment on lines
+1
to
+2
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| blank_issues_enabled: false | ||||||||||||
| contact_links: | ||||||||||||
| - name: Questions & help | ||||||||||||
| url: https://discord.gg/FErRRKU78j | ||||||||||||
| about: | ||||||||||||
| For usage questions, setup help, and general discussion, ask on Discord. | ||||||||||||
| - name: First-time contributor? Introduce yourself | ||||||||||||
| url: https://github.com/hyperdxio/hyperdx/issues/new?template=introduce-yourself.md | ||||||||||||
| about: Say hello and get vouched before your first pull request. | ||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| name: Feature request | ||
| about: Suggest an idea or improvement for HyperDX | ||
| title: '' | ||
| labels: enhancement, Needs Feedback | ||
| --- | ||
|
|
||
| **What are you trying to do?** | ||
|
|
||
| <!-- The problem or use case, not just the solution. What's getting in your way today? --> | ||
|
|
||
| **What would you like to see?** | ||
|
|
||
| <!-- Your proposed change or behaviour. Rough is fine — we'll figure out the details together. --> | ||
|
|
||
| **Alternatives you've considered** | ||
|
|
||
| <!-- Workarounds you're using now, or other approaches you thought about. --> | ||
|
|
||
| **Anything else?** | ||
|
|
||
| <!-- Screenshots, mockups, links, or where in HyperDX this fits (UI, API, collector, CLI). --> | ||
|
|
||
| --- | ||
|
|
||
| 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). |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔵 minor — New flow says nothing about existing issues and Only new issues get Advisory. Fix if it is a small defect in code this PR changes; otherwise reply in the thread. Do not widen the PR or touch files it did not already change. How to respond |
||
| `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 | ||
|
|
||
|  | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔵 minor — Debug info blurb doesn't mention everything the report pastes into a public issue
The report built by
buildReport()inpackages/app/src/hdxDebug.ts:178-197also includes the user id, team id, the current page path and the enabled feature flags, not just "versions, deployment mode, browser, and session id". The page path can contain dashboard or saved-search ids. List those fields in the comment (e.g. "…session id, your user/team id and current page path…") so people know what they're posting publicly and can redact it.Advisory. Fix if it is a small defect in code this PR changes; otherwise reply in the thread. Do not widen the PR or touch files it did not already change. How to respond