Skip to content

docs: vouch from first PR, require repro steps and UI screenshots - #3329

Merged
kodiakhq[bot] merged 3 commits into
mainfrom
brandon/oss-contribution-tweaks
Oct 13, 2026
Merged

kodiakhq[bot] merged 3 commits into
mainfrom
brandon/oss-contribution-tweaks

Conversation

@brandon-pereira

Copy link
Copy Markdown
Member

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-vouch label 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-stack yarn dev provisions 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

  • Existing open intro issues aren't closed automatically, and the introduction label still exists.

References

  • Related PRs:

@vercel

vercel Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
hyperdx-oss Ready Ready Preview Oct 13, 2026 3:18pm UTC
hyperdx-storybook Ready Ready Preview Oct 13, 2026 3:18pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 897ef6c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added the review/tier-2 Low risk — AI review + quick human skim label Oct 8, 2026
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

🔵 Tier 2 — Low Risk

Small, isolated change with no API route or data model modifications.

Why this tier:

  • Standard feature/fix — introduces new logic or modifies core functionality

Review process: AI review + quick human skim (target: 5–15 min). Reviewer validates AI assessment and checks for domain-specific concerns.
SLA: Resolve within 4 business hours.

Stats
  • Production files changed: 1
  • Production lines changed: 8
  • Branch: brandon/oss-contribution-tweaks
  • Author: brandon-pereira

To override this classification, remove the review/tier-2 label and apply a different review/tier-* label. Manual overrides are preserved on subsequent pushes.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Duplicate code analysis

No new duplicate code introduced by this PR.


jscpd compared this branch against origin/main
across app, api and common-utils. Only new clones are listed; the codebase
currently holds 125 in total (1.75%).
Run yarn dupes locally to reproduce, or yarn dupes:all for the full picture.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

PR Review

If you are a coding agent acting for the author, read this first.
Nothing below blocks merge automatically; a maintainer decides. What they will expect:

  • 🔴 critical or 🟠 major in code this PR adds or changes: fix before asking for review.
  • 🔵 minor in code this PR changes: your call. Fix if small, otherwise reply.
  • Anything about surrounding code, or asking you to widen the change (hoist a helper,
    dedupe with another file, fix other call sites): never fix here, whatever the
    severity. Reply with one sentence; if it is critical, say so plainly so a human sees it.

One commit per review round. After two rounds, stop and ask a maintainer to review
scope rather than addressing more automated findings. Full rule: AGENTS.md.

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.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Deep Review

✅ No critical issues found.

This is a docs / issue-and-PR-template / CI-comment-text change. All substantive checks passed: the deleted introduce-yourself.md template has no lingering references, every internal anchor (#getting-vouched, #reproducing-issues-and-prs, #ui-changes-need-beforeafter-screenshots, #development) resolves, the vouch.yml github-script comment template literal is syntactically valid, and the new CONTRIBUTING prose matches actual app behavior (demo-connection constants, local-mode sessionStorage connections vs localStorage sources, demo-button gating, and yarn dev auto-provisioning). The prior Greptile comment about connection storage wording was already corrected by the author.

🔵 P3 nitpicks (2)
  • .github/workflows/vouch.yml:150 — The bot comment hardcodes the "what makes a first PR easy to vouch for" checklist (linked issue, repro steps, before/after screenshots) that also lives in CONTRIBUTING.md#getting-vouched, and the comment already links there, so the two can drift when one is edited.
    • Fix: Consider trimming the inline bullets toward the existing CONTRIBUTING.md link so the guide stays the single source of truth, or accept the duplication deliberately since unvouched contributors see the comment without clicking through.
  • CONTRIBUTING.md:104 — The yarn app:dev:local command and the "Connect to Demo Server" button label are now repeated across CONTRIBUTING.md, AGENTS.md, .github/pull_request_template.md, .github/ISSUE_TEMPLATE/bug-report.md, and .github/workflows/vouch.yml; renaming either string requires editing all five.
    • Fix: Keep the detailed steps single-sourced in CONTRIBUTING.md (already the case) and treat the script name and button label as the brittle tokens to update together if they ever change.

Reviewers (4): correctness, maintainability, project-standards, previous-comments.

Testing gaps: No CI link-checker covers Markdown anchor fragments or cross-file blob links, so a future section rename would silently break the references added here; nothing enforces that the PR template's "How to reproduce" / "Screenshots or video" headings stay in sync with the AGENTS.md and CONTRIBUTING.md pointers.

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

@greptile-apps

greptile-apps Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

[Low impact] The PR appears safe to merge; no actionable new issue was found.

Summary

Moves first-time contributor vouching to the first PR and removes the introduction issue template.

  • First-time contributors get vouched through their open pull request.
  • Bug reports and pull requests show reviewers how to reproduce changes.
  • UI pull requests include matching before-and-after screenshots.

The earlier storage wording is fixed: the guide now says connections last for the browser session. That thread was unnumbered, so it has no previousFindings entry.

Reviews (3) · Last reviewed commit: "Merge branch 'main' into brandon/oss-con..." · Reviewed by Greptile

Comment thread CONTRIBUTING.md Resolved
@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

E2E Test Results

✅ All tests passed • 407 passed • 1 skipped • 1741s

Status Count
✅ Passed 407
❌ Failed 0
⚠️ Flaky 1
⏭️ Skipped 1

Tests ran across 4 shards in parallel.

View full report →

`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.`,

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 — 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

@kodiakhq
kodiakhq Bot merged commit 8fa3374 into main Oct 13, 2026
29 checks passed
@kodiakhq
kodiakhq Bot deleted the brandon/oss-contribution-tweaks branch October 13, 2026 15:26

This branch was successfully deployed

2 active deployments
Preview – hyperdx-oss — 897ef6cf Deployed Oct 13, 2026 by vercel[bot]
Preview – hyperdx-storybook — 897ef6cf Deployed Oct 13, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automerge review/tier-2 Low risk — AI review + quick human skim

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants