Skip to content

Commit 8ca9844

Browse files
committed
Add friendly README visuals
1 parent 1d9ab9a commit 8ca9844

1 file changed

Lines changed: 19 additions & 18 deletions

File tree

README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GitHub Codex PR Loop
1+
# 🔁 GitHub Codex PR Loop
22

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

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

88
In practical terms, it can:
99

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

18-
##### NOTE: This is an independent community project. It is not affiliated with, endorsed by, or supported by OpenAI or GitHub.
18+
> ℹ️ **Independent project:** This community project is not affiliated with,
19+
> endorsed by, or supported by OpenAI or GitHub.
1920
20-
## Why use it?
21+
## 🤷🏽‍♀️ Why use it?
2122

2223
A pull-request review is rarely one step:
2324

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

35-
## What does “the exact version” mean?
36+
## 🤔 What does “the exact version” mean?
3637

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

57-
## Choose a mode
58+
## 🎛️ Choose a mode
5859

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

70-
## Example prompts
71+
## 💬 Example prompts
7172

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

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

95-
## Built-in limits
96+
## 🛡️ Built-in limits
9697

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

108-
## Requirements for v0.1.0
109+
## Requirements for v0.1.0
109110

110111
For every mode:
111112

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

136-
## Install v0.1.0
137+
## 📦 Install v0.1.0
137138

138139
Ask Codex:
139140

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

154-
## What can it change?
155+
## 🔧 What can it change?
155156

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

@@ -227,7 +228,7 @@ Automation owned by this exact run.
227228

228229
</details>
229230

230-
## Validate the skill
231+
## 👮🏽‍♂️ Validate the skill
231232

232233
Run:
233234

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

242-
## License
243+
## 📄 License
243244

244245
[MIT](LICENSE)

0 commit comments

Comments
 (0)