Skip to content

docs: Describe the compact OpenAI review report #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
idy wants to merge 1 commit into from
Closed

docs: Describe the compact OpenAI review report #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ superseded snapshots only after a replacement upload succeeds.
- Every accepted review creates three fixed Check Runs on the exact PR head:
`OpenAI PR Review`, `OpenAI Issue Review`, and `OpenAI Code Review`. Each
reports its own running, successful, failed, or cancelled state, while one
native `## 🤖 OpenAI PR review` report contains the combined evidence.
native `OpenAI PR Review` report contains the combined conclusion. Its
default view keeps the PR-format, Issue-design, and code/plan-conformance
verdicts visible alongside the reviewed scope and aggregate usage.
- `OpenAI PR Review` checks the title, body, and native closing-Issue linkage.
`OpenAI Issue Review` checks every linked Issue independently and aggregates
their format and design verdict. `OpenAI Code Review` checks only code
Expand All @@ -56,10 +58,11 @@ superseded snapshots only after a replacement upload succeeds.
per-million-token model rate card: uncached input uses the input rate,
cached input uses the cached-input rate, and output (including reasoning)
uses the output rate. This is a token-derived estimate, not an API billing
ledger value. The report includes the stable PR session key, content-addressed
generation key, reviewed commit range, deterministic diff chunk count, and
per-stage usage. The stage table identifies full, incremental, reused, and
deterministic work, including a separate row for every linked Issue.
ledger value. Folded report sections retain the stable PR session key,
content-addressed generation key, reviewed commit range, deterministic diff
chunk count, and per-stage usage. The stage table identifies full,
incremental, reused, and deterministic work, including a separate row for
every linked Issue.
Reused and deterministic rows consume zero model tokens. Cached-input tokens
are part of input tokens, and reasoning-output tokens are part of output
tokens; neither is added to the total a second time.
Expand Down
Loading