Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?**
Expand Down Expand Up @@ -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

Copy link
Copy Markdown
Contributor

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() in packages/app/src/hdxDebug.ts:178-197 also 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

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Debug info includes identifiers The copied block also contains user and team IDs when available. Because reporters are asked to paste it into a public issue, please tell them to review or redact those IDs before posting. Otherwise, they may disclose account details unintentionally.

Suggested change
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).
block below. It captures versions, deployment mode, browser, session id, and
user and team IDs when available. No API keys or query params are included.
Review and redact identifiers before posting publicly. Skip it if you're only
hitting the collector or CLI (write N/A).

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!

Fix in Claude Code Fix in Conductor Fix in Cursor Fix in Codex

-->

```
(paste Help → Copy debug info here)
```

**Logs**

<!--
Expand Down
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Label guarantee is overstated Disabling blank issues does not make every new issue pick up Needs Feedback. The “Introduce yourself” template applies only introduction, and the new contact link opens that template. Narrow this comment to bug reports and feature requests so maintainers do not rely on a guarantee the configuration does not provide.

Suggested change
# 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.
# Blank issues are disabled so new issues start from a template.
# Bug reports and feature requests pick up `Needs Feedback`; introduction
# issues use the `introduction` label. Use the templates or the links below.

Fix in Claude Code Fix in Conductor Fix in Cursor Fix in Codex

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.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
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).
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 minor — New flow says nothing about existing issues and good first issue issues that have neither label

Only new issues get Needs Feedback. Existing open issues, including the good first issue list that CONTRIBUTING.md:24-25 and introduce-yourself.md recommend, have neither Needs Feedback nor Accepting PR, so it's unclear whether they're open for PRs. Add a sentence covering unlabeled or good first issue issues, or backfill Accepting PR on them.

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

![architecture](./.github/images/architecture.png)
Expand Down
Loading