Skip to content

Commit 50a7388

Browse files
leo-aa88cursoragent
andcommitted
docs(contributing): note fork PRs skip Agentic PR review check
External contributors often miss the automated review workflow on fork PRs because the job requires same-repo head and repository secrets. Document the behavior and point to GITHUB_ACTIONS.md for full details. Closes #95 Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 4141e1d commit 50a7388

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,28 @@ High-level map (details in [`README.md`](README.md) and [`docs/DESIGN_DOC.md`](d
7474
- Link related **issues** when applicable.
7575
- Ensure **CI would pass** (formatting, vet, tests, build). Note: pushes that **only** change `Makefile` or `**/*.md` do not trigger CI via `paths-ignore`; for doc-only edits, run `make ci` locally if you also changed Go code elsewhere in the same branch.
7676

77+
### Agentic PR review (fork and first-time contributors)
78+
79+
This repository runs an automated **Agentic PR review** workflow
80+
([`.github/workflows/agentctl-pr-review.yml`](.github/workflows/agentctl-pr-review.yml)) on pull
81+
requests. You may **not** see that check on your PR in these common cases:
82+
83+
- **Fork-originated PRs** — the `review` job runs only when the PR head branch lives in the
84+
**canonical** repository (`github.event.pull_request.head.repo.full_name == github.repository`).
85+
Fork PRs intentionally skip the job so CI does not fail from missing repository secrets (for
86+
example **`OPENAI_API_KEY`**), which GitHub does not expose to workflows triggered from forks.
87+
- **First PR that adds the workflow** — GitHub often schedules `pull_request` workflows from the
88+
default branch definition; a brand-new workflow file may not run on the PR that introduces it
89+
until it is merged to **`main`** (later PRs then get the check).
90+
91+
That is expected. Maintainers can still validate your change: push the same commits to a branch on
92+
the canonical repo (for example after opening the fork PR) or re-run review from an in-repo branch
93+
when appropriate.
94+
95+
For permissions, secrets, exit code **5**, and other Actions details, see
96+
**[`docs/GITHUB_ACTIONS.md`](docs/GITHUB_ACTIONS.md)** (sections on fork PRs and first-time workflow
97+
introduction).
98+
7799
## License
78100

79101
By contributing, you agree that your contributions will be licensed under the same terms as the project: **[MIT](LICENSE)**.

0 commit comments

Comments
 (0)