Skip to content

Commit b28105a

Browse files
committed
docs: Document automated code review workflow limitations
Added section explaining that fork PRs cannot access the automated Claude Code review workflow due to GitHub's security model. This helps set expectations for external contributors. Contributors can still submit PRs from forks - they just won't get automated Claude reviews. Maintainers can manually transfer branches if automated review is desired.
1 parent 91ac16b commit b28105a

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,28 @@ npm test
245245
- Ensure all tests pass (CI will check automatically)
246246
- Respond to review feedback
247247

248+
### Automated Code Review Workflow
249+
250+
This repository uses [Claude Code](https://claude.com/claude-code) for automated code reviews on pull requests.
251+
252+
**Important Note for External Contributors:**
253+
254+
Due to GitHub's security model, automated workflows cannot access secrets or authentication tokens for pull requests from forked repositories. This means:
255+
256+
-**PRs from branches in `malston/chrome-tabs`** will receive automated Claude code reviews
257+
-**PRs from forked repositories** will not trigger the automated review workflow
258+
259+
**If you're contributing from a fork:**
260+
261+
Your PR will still be reviewed manually by maintainers. The automated Claude review is a convenience feature but not required for contributions to be accepted.
262+
263+
If you'd like automated review on your PR, a maintainer can:
264+
1. Fetch your branch from your fork
265+
2. Push it to the main repository
266+
3. Create a new PR from the main repository branch
267+
268+
This limitation exists to protect repository secrets and is a standard security practice for GitHub Actions workflows.
269+
248270
### Skipping Pre-commit Hooks
249271

250272
If you need to commit without running hooks (not recommended):

0 commit comments

Comments
 (0)