Github Pull Request

GitHub Pull Request

Prepare a concise, reviewer-focused pull request from the finalized branch changes. Use the project template and submit the pull request only after the user approves the description.

Workflow

1. Detect the base branch from the remote:

   BASE=$(gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name')
   

2. Compare the current branch with the base branch. Describe the final result, not superseded work from earlier commits.
3. Generate .scratchpad/PR.md with a concise summary, explicit design decisions, and implementation-note subheadings that describe each decision group's shared goal or motif.
   • Follow the pull request template.
4. Pause here and prompt the user to check the .scratchpad/PR.md before proceeding.
5. Once edited and approved by the user, fill in the missing details in the following script and then run it:

   HEAD=$(git rev-parse --abbrev-ref HEAD)
   gh pr create --base "$BASE" --head "$HEAD" --title 'category(scope): concise title' --body-file .scratchpad/PR.md
   

6. Delete .scratchpad/PR.md once successfully submitted.

Pull Request Title Guidelines

• Examine the commit messages that make up the pull request for inspiration
• Keep it short and sweet, encapsulating a summary of the implemented feature concisely in imperative form
• Use category specifiers like feat, fix, docs, chore, deps, etc. (consistent with the Conventional Commits message style)
• Determine the scope of the changes based on the most affected part of the codebase
• Refer to the GitHub issues provided by the user (if applicable)
  • Mention these issues in natural-flowing prose (with respect to the pull request description)
  • Use keywords like closes, fixes, and resolves