Gate external PRs on an assigned, linked issue - #3291
Conversation
cb39e81 to
d618e7b
Compare
There was a problem hiding this comment.
Review completed against the latest diff
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Unsolicited pull requests now outnumber issues four to one and almost none are reviewable in the time we have. This adds a workflow that closes an external PR unless its description links an open issue the author is assigned to (or one labeled "help wanted"), and reopens it automatically once a maintainer assigns them. Anyone with triage or better, bots and drafts are exempt; reopening a PR, removing the control label, or adding the bypass label is a sticky maintainer override. PRs numbered below 3200 predate the gate and are only evaluated on manual dispatch. It is live from merge; setting the PR_GATE_ENFORCE repository variable to "false" turns it log-only. The rules live in .github/scripts/pr_intake_gate.js with scenario tests beside it (run in the checks job); the workflow file is triggers, routing and a checkout + require. Adapted from PrefectHQ/fastmcp's require-issue-link.yml (itself from langchain). CONTRIBUTING.md is rewritten around the policy (issues are the contribution; how PRs get in; who we'd love to hear from), AGENTS.md points agents at it, and the repo-level PR template is the org template plus a short note about the gate. No-Verification-Needed: workflow, its script and tests, and docs only Signed-off-by: Max Isbey <224885523+maxisbey@users.noreply.github.com>
8f0d415 to
1e7b8d9
Compare
…ns per assignee Also reword the refused-reopen advice for PRs that passed via a maintainer override, and drop an unused test fixture. No-Verification-Needed: workflow script, its tests, and config only Signed-off-by: Max Isbey <224885523+maxisbey@users.noreply.github.com>
| If you are an AI coding agent acting for someone who is not a maintainer of | ||
| this repository, read `CONTRIBUTING.md` before opening issues or pull | ||
| requests here. In particular, pull requests that aren't linked to an issue |
There was a problem hiding this comment.
🟡 [quality] nit: docs summarize the gate as assignment-only, dropping the help wanted path the gate itself honors sweep:assigned to (their author|the linked issue first) — AGENTS.md's agent note says PRs "that aren't linked to an issue assigned to their author are closed automatically", and CONTRIBUTING.md's setup step 9 says "you need to be assigned to the linked issue first"; both omit that a linked open issue labeled help wanted also keeps the PR open (pr_intake_gate.js line 105, CONTRIBUTING.md "How Pull Requests Get In" condition 2, and the PR template checklist all include it). Fix: add the help-wanted qualifier (e.g. "assigned to their author or labeled help wanted") at both sites.
Extended reasoning...
Concrete cost: a written rule stated inconsistently within the same PR. AGENTS.md is @-imported by CLAUDE.md, so every coding agent working in this repo is told the gate closes any PR whose linked issue isn't assigned to the author — per that rule, an agent helping a contributor with a help wanted issue (the one case CONTRIBUTING explicitly invites PRs from anyone for) would wrongly warn that the PR will be auto-closed or steer the user to wait for an assignment that is not required; a human following Development Setup step 9 ("you need to be assigned to the linked issue first") is misled the same way. The gate's actual rule (pr_intake_gate.js line 105 passes on the help wanted label with no assignment) and the PR template's checkbox ("I am assigned to the linked issue (or it is labeled help wanted...)") both contradict these two summaries.
Verification: nit — the factual claim checks out. The gate itself honors two paths: /home/claude/python-sdk/.github/scripts/pr_intake_gate.js:105-106 passes when the linked open issue "is labeled "help wanted"" OR when "author is assigned", and CONTRIBUTING.md states both paths at line 21 ("A maintainer has assigned that issue to you, or the issue carries the help wanted label") and line 59 ("no
Adds an intake gate for pull requests from outside the maintainer team: a PR stays open only if it links an open issue its author is assigned to (or one labeled
help wanted). Everything else is closed by a bot with an explanation and reopens automatically once a maintainer assigns the author. CONTRIBUTING.md is rewritten around that policy.Motivation and Context
Over the last six months this repo received ~640 pull requests from outside the maintainer team — 2.7× the previous six months — of which 24 were merged. 41% of newly opened issues now attract an external PR within 48 hours (median under 11 hours), the open-PR backlog is ~80% external, and CONTRIBUTING.md's existing "issue first, no drive-by agents" rules have no mechanical backing. Reviewing a PR properly costs the same as it always did; producing one no longer does. With the maintainer time we actually have, issues are the contribution we can use, and this makes the repo say so and behave accordingly.
The workflow is adapted from PrefectHQ/fastmcp's
require-issue-link.yml(which came from langchain's); pydantic and pydantic-ai run similar gates. Within this org, inspector has already gone issues-only and typescript-sdk restricted PR creation for a month in June for the same reason.Behaviour
Fixes/Closes/Resolvesan open issue in this repo where the author is an assignee, or the issue carrieshelp wanted. Otherwise:missing-issue-linklabel, one comment, closed.editedevent; anyone triage+ reopens the PR, removes the label, or addsbypass-issue-check→ sticky override.workflow_dispatch; from 3200 up a PR is evaluated on its next event. Once labeled, a PR is managed normally regardless of number.PR_GATE_ENFORCEtofalseis a kill switch: runs then logPASS/FAILand[dry-run] would …lines and mutate nothing.Differences from the fastmcp version (also listed in the file header): the rules live in
.github/scripts/pr_intake_gate.js(with scenario tests beside it) and the workflow is just triggers and routing; one script serves all entry points (PR events, issue assignment, manual dispatch) so admission and reopening can't drift; PR state is always read live rather than from the event payload; linked issues must be open and still in this repo; gated PRs are found with the list API rather than Search; reopen happens before the label is removed and a refused reopen is explained rather than guessed at; trust from capability flags rather than role-name strings; the waiver label is our existinghelp wanted.Docs
ready for workmeans queued for a maintainer, not an invitation)..github/pull_request_template.md: a short repo-level template that leads with theFixes #line the gate looks for, replacing the inherited org template here.How Has This Been Tested?
.github/scripts/pr_intake_gate.test.js: 26 named scenarios (no link; link tohelp wanted; maintainer reopening their own vs a gated PR; triage-role and bot label removal; the bypass label; Dependabot; hand-closed and merged PRs; closed/transferred/cross-repo/PR-number references; refused reopen and the retry after it; issue assignment incl. past the reference cap; dispatch backfill; drafts; a planted marker comment) plus kill-switch and fail-safe cases, run in CI on Node 24.actionlintandzizmor --pedanticclean (thepull_request_targettrigger carries an inline justification; the workflow never checks out or executes PR code and interpolates nothing from the PR into the script).collaborators/{user}/permissioncapability flags for admins, outsiders and app logins;issues.listForRepowithcreator+labels+state=closed;minimizeComment/unminimizeComment) were checked against the live API, and the same permission set is what fastmcp's copy has been running with since May.Breaking Changes
None for SDK users. For contributors: PRs opened without an assigned, linked issue will be closed automatically once enforcement is on; CONTRIBUTING.md describes the path.
Types of changes
Checklist
Additional context
Rollout after merge:
PR_GATE_ENFORCE=falsepauses it.help wanted/ready for worklabel descriptions to match CONTRIBUTING.md.gh workflow run require-linked-issue.yml -f pr_number=<n>.AI Disclaimer