Repository navigation
docs: add Codex agent instructions - #7
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new documentation file, AGENTS.md, which provides comprehensive guidance for AI agents (such as Codex) working within the repository. It details the project overview, build commands, development workflows, architecture, and testing patterns. The review feedback correctly points out an inaccuracy in the pull request approval workflow instructions, noting that GitHub does not permit self-approval even via the Web UI, and suggests a clear correction.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| 7. **Approve the PR** (required for solo dev workflow): | ||
|
|
||
| **Note**: GitHub doesn't allow self-approval via CLI. You must use the web UI: | ||
|
|
||
| - Go to the PR page | ||
| - Click **"Files changed"** tab | ||
| - Click **"Review changes"** button (top right) | ||
| - Select **"Approve"** | ||
| - Click **"Submit review"** | ||
|
|
||
| Or use admin bypass (see alternative workflow below). |
There was a problem hiding this comment.
GitHub does not allow pull request authors to approve their own pull requests, even through the Web UI (the Approve option is disabled for the author). For a solo developer workflow, requiring approvals on branch protection is typically disabled, or the admin bypass/force merge is used. This section should be updated to reflect that self-approval is not possible.
| 7. **Approve the PR** (required for solo dev workflow): | |
| **Note**: GitHub doesn't allow self-approval via CLI. You must use the web UI: | |
| - Go to the PR page | |
| - Click **"Files changed"** tab | |
| - Click **"Review changes"** button (top right) | |
| - Select **"Approve"** | |
| - Click **"Submit review"** | |
| Or use admin bypass (see alternative workflow below). | |
| 7. **Approve the PR** (if working in a team): | |
| **Note**: GitHub does not allow self-approval. If you are working with others, another contributor must approve your PR. For solo developers, you cannot approve your own PR (even via the web UI) and must rely on admin bypass or disable the approval requirement. |
There was a problem hiding this comment.
Thanks — fixed in 308851f. Step 7 in both AGENTS.md and CLAUDE.md now states that GitHub blocks self-approval (CLI and web UI) and routes solo devs to the existing admin-bypass section.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f2fbd9f321
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| 7. **Approve the PR** (required for solo dev workflow): | ||
|
|
||
| **Note**: GitHub doesn't allow self-approval via CLI. You must use the web UI: |
There was a problem hiding this comment.
For the documented solo-developer workflow, switching to the web UI does not enable self-approval: GitHub explicitly states that pull request authors cannot approve their own pull requests (GitHub Docs). A solo author following this required step will be blocked; direct them to obtain another review or use the documented admin-bypass workflow instead.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Accepted — fixed in 308851f. Step 7 in both AGENTS.md and CLAUDE.md now explicitly says GitHub does not allow PR authors to approve their own PRs and routes solo devs to the admin-bypass workflow already documented below.
Add AGENTS.md as the Codex-specific counterpart to CLAUDE.md. The file preserves the existing repository guidance for build, test, release, workflow, architecture, and contribution practices, while updating agent-facing references from Claude Code to Codex. This lets Codex pick up the same project instructions without changing the Claude-specific guidance.
GitHub blocks PR authors from approving their own PRs — neither via CLI nor web UI. The previous step 7 instructed solo devs to approve through the web UI, which doesn't work. Rewrites step 7 in both AGENTS.md and CLAUDE.md to: - Explicitly state self-approval is not possible - Direct team workflows to get an external reviewer - Direct solo workflows to the existing admin-bypass section
034bd4f to
7feeb9c
Compare
2 participants
Summary
Add
AGENTS.mdas the Codex-specific counterpart toCLAUDE.md.The new file preserves the existing repository guidance for build, test, release, workflow, architecture, and contribution practices, while updating agent-facing references from Claude Code to Codex.
Validation
AGENTS.mdagainstCLAUDE.md