| name | github-pr-workflow |
| description | Use when creating, updating, reviewing, testing, or merging a GitHub pull request |
GitHub PR Workflow
Overview
Keep pull request work reviewable: one branch, one purpose, clear tests, and a concise body.
Workflow
- Inspect status:
git status --short --branch
git remote -v
- Create a branch with a conventional prefix:
git checkout -b codex/short-description
- Make scoped changes and run relevant tests.
- Stage only intended files:
git add README.md docs/SKILL_CATALOG.md
git diff --cached --stat
- Commit with a precise message:
git commit -m "docs: improve public skill catalog"
- Push and open the PR:
git push -u origin HEAD
gh pr create --fill
PR Body
Include:
- Summary
- Verification
- Risk or rollback notes
- Screenshots for visible docs/site changes when useful
Safety
- Do not include private config, real credentials, private logs, or local cache files.
- Run the repo safety audit before opening public PRs.