From 8ca9844e96a8473399c1f2b566d788eac926cba6 Mon Sep 17 00:00:00 2001 From: Vicc <1724674+vicc@users.noreply.github.com> Date: Thu, 23 Jul 2026 14:04:00 -0700 Subject: [PATCH] Add friendly README visuals --- README.md | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index adb24d2..5fbe3ad 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# GitHub Codex PR Loop +# ๐Ÿ” GitHub Codex PR Loop **Let Codex handle the pull-request review loop.** @@ -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: @@ -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. @@ -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 | | --- | --- | --- | @@ -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. @@ -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. @@ -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: @@ -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: @@ -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: @@ -227,7 +228,7 @@ Automation owned by this exact run. -## Validate the skill +## ๐Ÿ‘ฎ๐Ÿฝโ€โ™‚๏ธ Validate the skill Run: @@ -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)