Repository navigation
docs(github): add debug-info ask and Needs Feedback issue flow - #3239
Conversation
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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
🔵 Tier 2 — Low RiskSmall, isolated change with no API route or data model modifications. Why this tier:
Review process: AI review + quick human skim (target: 5–15 min). Reviewer validates AI assessment and checks for domain-specific concerns. Stats
|
Duplicate code analysisNo new duplicate code introduced by this PR. jscpd compared this branch against |
| <!-- | ||
| 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 |
There was a problem hiding this comment.
🔵 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
| 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 |
There was a problem hiding this comment.
🔵 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
PR Review
2 finding(s): 🔴 0 critical · 🟠 0 major · 🔵 2 minor 2 posted as inline comment(s) on the changed lines. Severity is the reviewer's own estimate and is used for ordering, not filtering. No finding blocks merge automatically; a maintainer decides. |
Deep Review✅ No critical issues found. This is a prose/config-only change to GitHub issue templates and 🟡 P2 -- recommended
🔵 P3 nitpicks (2)
Reviewers (3): correctness, maintainability, project-standards. Testing gaps: none — documentation and issue-template config carry no automated tests, and the label dependency above is validated by the repo's label configuration rather than code. No finding blocks merge automatically. A maintainer will expect P0/P1 findings in code this PR changes to be fixed; P2/P3 are your call -- fix or reply. Never fix findings about surrounding code here; reply instead. Do not widen the PR. How to respond |
|
| 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). |
There was a problem hiding this comment.
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.
| 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!
| # 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. |
There was a problem hiding this comment.
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.
| # 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. |
E2E Test Results✅ All tests passed • 385 passed • 1 skipped • 1305s
Tests ran across 4 shards in parallel. |
Why
Two intake improvements requested for the issue templates:
What changed
bug-report.md— new Debug info section pointing to Help → Copy debug info, with a paste block. Strongly requested for UI bugs,N/Afor collector/CLI. Also auto-labels new bugsNeeds Feedback.feature-request.md(new) — problem / proposal / alternatives / extras; auto-labelsenhancement, Needs Feedback; explains the flow.config.yml(new) — disables blank issues so every issue starts from a template (and picks upNeeds Feedback); adds Discord + introduce-yourself contact links.CONTRIBUTING.md— new "From issue to pull request" section:Needs Feedback= still discussing, don't PR yet; a maintainer swaps it forAccepting PR= ready to pick up. Convention layered on top of the existing vouch trust gate — no PR-side enforcement.Flow
Label swap is manual by design (no new workflow). Gating is convention + docs only.
Required follow-up (labels must exist)
Front-matter labels only apply if the label already exists in the repo. Create once:
Note
blank_issues_enabled: falseremoves the "open a blank issue" escape hatch — that's what guarantees the label is applied. If maintainers rely on blank issues, drop that line (I can instead add a small backfill workflow to label unlabeled issues on open).Not included
No changeset —
.githubtemplates +CONTRIBUTING.mdonly, no published-package behavior change.