Repository navigation
docs: vouch from first PR, require repro steps and UI screenshots - #3329
Conversation
|
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 |
PR Review
1 finding(s): 🔴 0 critical · 🟠 0 major · 🔵 1 minor 1 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 docs / issue-and-PR-template / CI-comment-text change. All substantive checks passed: the deleted 🔵 P3 nitpicks (2)
Reviewers (4): correctness, maintainability, project-standards, previous-comments. Testing gaps: No CI link-checker covers Markdown anchor fragments or cross-file 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 |
|
E2E Test Results✅ All tests passed • 407 passed • 1 skipped • 1741s
Tests ran across 4 shards in parallel. |
| `Hi @${pr.user.login}, thanks for the pull request!`, | ||
| ``, | ||
| `Before we review code from a first-time contributor we ask that a maintainer vouches for you, and you're not on our list yet. **This PR stays open** — it just isn't in the review queue until someone vouches.`, | ||
| `Before we review code from a first-time contributor, a maintainer vouches for them, and you're not on our list yet. **There's nothing else to file and this PR stays open** — a maintainer will look at it, usually within a day or two, and vouch for you right here if it's a genuine attempt at the problem.`, |
There was a problem hiding this comment.
🔵 minor — needs-vouch label is never removed after a maintainer vouches on the PR, which is now the normal path
Under the old flow most contributors got vouched before opening a PR, so the label was uncommon. Now every first PR gets needs-vouch, and nothing ever clears it. check-pr only runs on opened/reopened/ready_for_review, and the manage job (manage-by-issue, line 191) only opens a VOUCHED.td PR. A grep of .github/ finds no other code that touches the label. Vouched PRs stay labelled and look like they are still out of the review queue. Fix: in the manage job, after a successful /vouch on a PR (github.event.issue.pull_request is set), call issues.removeLabel for needs-vouch. Alternatively, have check-pr drop the label when status is vouched.
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
Summary
Changes how outside contributions come in, to cut noise and make PRs quicker to review. Docs, templates and bot comment text only: no new checks.
Vouching now happens on the first PR, not before it. The "Introduce yourself" issue template mostly attracted vouch requests that never turned into code. It's removed. The vouch bot's comment on an unvouched PR now says a maintainer will vouch right there on the PR, and lists what makes that quick (linked issue, repro steps, screenshots). CONTRIBUTING tells maintainers to vouch from a PR, not from an issue with no code behind it. The
needs-vouchlabel and open-PR caps work as before.Every PR and bug report needs reproduction steps. There's a new CONTRIBUTING section. Start from play.hyperdx.io if the bug shows there. Otherwise use
yarn app:dev:local→ onboarding → Connect to Demo Server, which is the same local mode the Vercel preview runs. Full-stackyarn devprovisions a local ClickHouse connection per team, so onboarding never offers the demo button there. The docs say to use it only for API-dependent changes (alerts, webhooks, auth, teams), and how to point it at the demo data by hand. The PR template gets a "How to reproduce" section (main vs branch), and the bug report asks whether it reproduces on play.UI PRs need before/after screenshots. Required in CONTRIBUTING and AGENTS.md: same screen, data, viewport and theme, and a video for interactions. Agents that can't capture screenshots must say so instead of leaving the table empty.
Follow-ups
introductionlabel still exists.References