Skip to content

Add Codex PR structure guidelines #121

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

Merged
Tibo2403 merged 1 commit into from
Jul 5, 2026
Merged

Add Codex PR structure guidelines #121

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
23 changes: 23 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,27 @@ Detected stack: Python, PowerShell
- Never commit credentials, local environment files, or generated secrets.
<!-- END CODEX WORKSPACE DOCTOR -->

## Pull Request, Merge, and Push Summaries

For every PR description, merge proposal, push summary, or release validation note, use this structure:

### What Problem This Solves

Explain the concrete bug, gap, or maintenance issue. Include the root cause when known.

### Why This Change Was Made

Explain the technical change and why this approach was chosen.

### User Impact

State whether runtime, product, user, maintainer, or developer behavior changes. If there is no behavior change, say so explicitly.

### Evidence

- Before: failing run, error message, limitation, or previous behavior
- Tests: targeted tests and results
- Checks: CI, lint, smoke tests, or manual validation
- Autoreview: clean, findings addressed, or not run

Keep the Evidence section factual. Prefer concrete commands, run links, failure messages, and pass/fail results over vague statements.