Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GitHub Codex PR Loop
# 🔁 GitHub Codex PR Loop

**Let Codex handle the pull-request review loop.**

Expand All @@ -7,17 +7,18 @@ re-review without letting the process run forever or merge code on its own.

In practical terms, it can:

1. Open or reuse a GitHub pull request.
2. Ask `@codex` to review the current version of the code.
3. Fix feedback that is clear and within the task you approved.
4. Run the repository's validation commands.
5. Push the fix and ask Codex to review again.
6. Stop when the latest review is clear, a safety check fails, or the loop
1. 📂 Open or reuse a GitHub pull request.
2. 🙋🏽 Ask `@codex` to review the current version of the code.
3. 🛠️ Fix feedback that is clear and within the task you approved.
4. 🖲️ Run the repository's validation commands.
5. ↗️ Push the fix and ask Codex to review again.
6. 🏁 Stop when the latest review is clear, a safety check fails, or the loop
reaches its limit.

##### NOTE: This is an independent community project. It is not affiliated with, endorsed by, or supported by OpenAI or GitHub.
> ℹ️ **Independent project:** This community project is not affiliated with,
> endorsed by, or supported by OpenAI or GitHub.

## Why use it?
## 🤷🏽‍♀️ Why use it?

A pull-request review is rarely one step:

Expand All @@ -32,7 +33,7 @@ ties every review to the exact version of the code that Codex reviewed.
The result is a repeatable workflow with clear limits, not an agent that keeps
changing your repository indefinitely.

## What does “the exact version” mean?
## 🤔 What does “the exact version” mean?

Git gives every commit a unique ID called a **SHA**. You can think of it as the
version number for one exact snapshot of your code.
Expand All @@ -54,7 +55,7 @@ It does **not** mean the code is guaranteed correct, secure, approved by a
human, or ready to merge. Tests, CI, required approvals, branch protection,
merge conflicts, and non-Codex review threads are still separate checks.

## Choose a mode
## 🎛️ Choose a mode

| Mode | Best for | What happens |
| --- | --- | --- |
Expand All @@ -67,7 +68,7 @@ Not sure which one to use? Start with `approval-gated`.
If you do not name a mode, v0.1.0 uses `autonomous` for backward compatibility.
First-time users should still choose `approval-gated` explicitly.

## Example prompts
## 💬 Example prompts

The skill runs only when you invoke `$github-codex-pr-loop` by name. Installing
it does not make it run automatically.
Expand All @@ -92,7 +93,7 @@ Use $github-codex-pr-loop in report-only mode on the existing PR against main.

Always name the base branch, such as `main`, explicitly.

## Built-in limits
## 🛡️ Built-in limits

- One main `@codex` review request per round.
- Up to 60 minutes for Codex to answer each request.
Expand All @@ -105,7 +106,7 @@ Always name the base branch, such as `main`, explicitly.
- The skill never merges, force-pushes, replaces remotes, retargets a PR,
deletes branches, or resolves human-authored review threads.

## Requirements for v0.1.0
## Requirements for v0.1.0

For every mode:

Expand Down Expand Up @@ -133,7 +134,7 @@ Not supported in v0.1.0:
- Repositories that cannot provide the documented safe execution boundary
without explicit risk acceptance.

## Install v0.1.0
## 📦 Install v0.1.0

Ask Codex:

Expand All @@ -151,7 +152,7 @@ credentials or a fine-grained token with read-only **Contents** access to the
repository. Never paste a token into a prompt. No repository credential will be
needed after the repository becomes public.

## What can it change?
## 🔧 What can it change?

In a write-capable mode, and only within the task you authorized, the skill may:

Expand Down Expand Up @@ -227,7 +228,7 @@ Automation owned by this exact run.

</details>

## Validate the skill
## 👮🏽‍♂️ Validate the skill

Run:

Expand All @@ -239,6 +240,6 @@ The test suite uses only the Python standard library. It checks the skill
contract and its public lifecycle fixtures, but it does not simulate GitHub,
Codex, or Automations end to end.

## License
## 📄 License

[MIT](LICENSE)