| name | branch |
| description | Start work on a GitHub issue with a correctly named branch and open its pull request, following this repo's GitHub Flow. Use when beginning a new issue, creating a feature branch, or opening a PR. Enforces branch naming, "Closes |
Branch and PR workflow
This repo uses GitHub Flow. The full rules live in docs/branching.md; this skill
executes them. Keep docs/branching.md as the source of truth: if it changes, follow it.
Starting an issue
- Make sure
main is current:
git switch main && git pull
- Create a branch named
<type>/<issue-number>-<short-slug>:
- types:
feat, fix, docs, chore, test
- example:
feat/12-invoice-extractor
git switch -c <branch>
- If the issue number or type is unclear, ask before creating the branch.
While working
- Commit in small steps with a conventional-commit prefix:
feat:, fix:, docs:, chore:, test:.
- One line is enough; add a body only when the WHY is not obvious.
- Keep the change scoped to the one issue.
Opening the PR
- Push the branch:
git push -u origin <branch>
- Open the PR with
gh, linking the issue so it closes on merge:
gh pr create --base main --title "<type>: <summary>" --body "Closes #<n>
<what and why>"
- CI (
.github/workflows/ci.yml) runs the smoke test on the PR. It must be green before merge.
- Get one teammate review. Pair review counts.
- Squash merge into
main:
gh pr merge --squash
Don'ts
- Never commit directly to
main.
- Don't bundle multiple issues into one branch or PR.