Github Pr Workflow

Use when creating, updating, reviewing, testing, or merging a GitHub pull request

Martin-Hausleitner Updated

File contents

GitHub PR Workflow

Overview

Keep pull request work reviewable: one branch, one purpose, clear tests, and a concise body.

Workflow

  1. Inspect status:
git status --short --branch
git remote -v
  1. Create a branch with a conventional prefix:
git checkout -b codex/short-description
  1. Make scoped changes and run relevant tests.
  2. Stage only intended files:
git add README.md docs/SKILL_CATALOG.md
git diff --cached --stat
  1. Commit with a precise message:
git commit -m "docs: improve public skill catalog"
  1. 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.

Martin-Hausleitner/martins-awesome-skills/tree/main/skills/github/github-pr-workflow commit f4b5f0008a

Frequently asked questions

npx skillmds@latest add martin-hausleitner/github-pr-workflow