Create Pull Request
Creates a GitHub pull request using the project's PR template and standard workflows.
Project Documentation References
- •AGENTS.md - Central reference for all project documentation
- •@git-conventions.md - Conventional commits and git workflows
- •@github-automation.md - GitHub project automation
Workflow
Step 1: Pre-Submission Checks
- •Lint and Typecheck: Ensure all checks pass.
bash
pnpm run lint && pnpm run typecheck
- •Tests: Ensure tests pass.
bash
pnpm run test
Step 2: Push Changes
- •Commit: Use conventional commits as per @git-conventions.md.
- •Push: Push the current branch to origin.
bash
git push -u origin HEAD
Step 3: Create PR
- •Template: The PR will automatically use the template in
.github/pull_request_template.mdwhen created viagh pr create. - •Execute: Use the
ghCLI to create the PR.bashgh pr create --title "feat: <description>" --body "$(cat .github/pull_request_template.md)" --draft (if needed)
Instructions
- •Analyze Changes: Briefly summarize the changes for the PR body.
- •Fill Template: Use the sections from the template in
.github/pull_request_template.md. - •Tenant Isolation: Explicitly confirm tenant isolation is maintained in the PR summary.
- •Link Issues: Link related GitHub issues to the PR.
Best Practices
- •Small PRs: Keep PRs focused on a single change.
- •Succinct Descriptions: Focus on the "why" and "how to test".
- •Draft PRs: Use draft status if the work is still in progress but you want feedback.