docs(contributing): document fork-PR workflow-approval gate for external contributors#41949
Open
pixu-bd wants to merge 1 commit into
Open
docs(contributing): document fork-PR workflow-approval gate for external contributors#41949pixu-bd wants to merge 1 commit into
pixu-bd wants to merge 1 commit into
Conversation
…nal contributors External contributors hit a silent blocker on every cross-repo PR: the upstream repo's "Require approval for first-time contributors" Actions setting queues workflow runs but does not execute them until a maintainer clicks "Approve and run" on the PR's banner. There is no email, no bot comment, no status update — the runs just sit in conclusion=action_required limbo with 0 jobs and 0 logs. This adds a "Fork-PR workflow approval gate (external contributors)" subsection under "Pull Request Process" that: - Explains what the gate is and why it exists - Shows the check_suites diagnostic that proves it's the gate (vs. the GitHub App starvation or workflow-file bugs) - Warns that force-push resets the gate (so the docstring-only follow-up pattern from CONTRIBUTING.md's "one logical change per PR" rule costs you both the review AND the workflow approval) - Recommends the salvage/<issue#> branch prefix used by other successful outside contributors (kshitijk4poor merged 15 cross-repo PRs in the last 5 days using this pattern) - Notes the ~8h maintainer review-batch cadence Single h3 subsection, 61 lines, 0 code changes, docs-only. This is the section I wish I'd had when my first three PRs sat quiet for 25+ hours after opening.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds a new subsection under
## Pull Request Process→### Commit messages(just before the## Reporting Issuesdivider) that documents the fork-PR workflow-approval gate for external contributors.Every cross-repo PR to
NousResearch/hermes-agentsits inconclusion: action_requiredlimbo until a maintainer clicks "Approve and run" on the PR's workflow banner. The runs show as queued-then-cancelled with 0 jobs and 0 logs, no email, no bot comment, no status update. External contributors currently have no way to learn this exists — it took 25+ hours of debugging to diagnose it on my own PRs.This is the section I wish I'd had when opening my first three PRs.
Related Issue
Fixes the discovery friction for any new external contributor. Not tied to a specific issue number.
Type of Change
Changes Made
CONTRIBUTING.md: new### Fork-PR workflow approval gate (external contributors)subsectioncheck_suitesdiagnostic that proves it's the gate (vs. GH App starvation or workflow bugs)salvage/<issue#>branch prefix and(salvage #<issue>)title pattern that other successful outside contributors use — kshitijk4poor merged 15 cross-repo PRs in the last 5 days following this pattern, and the established convention is the only signal that survives the workflow-approval gate cleanlyHow to Test
check_suitesdiagnostic against any open fork PR (e.g. feat(lsp): add csharp-ls and fsautocomplete via dotnet global tools #41056, feat(whatsapp): add group-gating controls #41054, fix(discord): render clarify choices as Select menu, not truncated buttons #41353) — should match the smoking-gun output described.grep -c "^## " CONTRIBUTING.mdshould be 21 (was 20).Checklist
Code
docs(contributing): ...)pytest tests/ -q— N/A, docs-onlyDocumentation & Housekeeping
cli-config.yaml.exampleif I added/changed config keys — N/ACONTRIBUTING.md— yes, exactly thisScreenshots / Logs
N/A — pure markdown documentation.
Context for reviewer
This is a docs-only PR. The workflow-approval gate that it documents is currently the #1 friction point for any external contributor — including me, today, on three different PRs (#41056, #41054, #41353). All three have been reviewed and approved (tonydwb, 2026-06-07), but the workflow-approval gate still requires a maintainer click to actually run CI. I had to use the
gh api check-suitesAPI to diagnose the silentaction_requiredruns, and the fix-and-share pattern in the new section is what I'd want future contributors to be able to do in 5 minutes instead of 5 hours.Low priority, low risk, high long-term payoff. Happy to revise framing or trim if any part feels editorialized.