| name | github |
| description | Work with GitHub in this repo: PR creation, CI checks, and gh CLI operations. |
GitHub
Overview
Use the GitHub CLI to create PRs, review checks, and inspect CI logs. Follow the repo conventions for commits and PR titles.
Commit conventions
Use Conventional Commits:
fix(bumba): stabilize workflows
Example:
fix(bumba): stabilize workflows
Create a PR
- Copy
.github/PULL_REQUEST_TEMPLATE.mdto a temp file. - Fill it out.
- Create the PR with
gh pr create.
cp .github/PULL_REQUEST_TEMPLATE.md /tmp/pr.md
$EDITOR /tmp/pr.md
gh pr create --body-file /tmp/pr.md
Check CI
gh pr checks 2259
gh run view 123456789 --log
Merge
Use squash merge, do not delete the branch via CLI:
gh pr merge 2202 --squash -R proompteng/lab
Resources
- Reference:
references/github-pr-guide.md - Helper:
scripts/create-pr.sh - Sample PR body:
assets/pr-body-template.md