Pr

Step 1: Prepare the branch

1. If on main, create a new branch with a descriptive name
2. Check for staged changes (git diff --cached --stat):
   • If there are staged changes: commit only the staged changes (do NOT git add anything else)
   • If nothing is staged: stage and commit all changes (except API keys or explicitly private content)
3. Push changes to the remote

Step 2: Create or update the PR

If no PR exists: Create a new PR following the standards below.

If a PR already exists (and is OPEN):

1. Show the user the existing PR (number, title, URL) and ask for confirmation using AskUserQuestion:

   • Update existing PR — push new commits to the current branch and update the PR title/description if needed
   • Create new branch & PR — create a new branch from the current one, push there, and open a fresh PR

2. If the user chose "Update existing PR":

   a. Read the existing PR:

   gh pr view --json title,body,labels,number
   gh pr diff --stat
   

   Read specific files directly rather than dumping the full diff.

   b. Review whether the PR content accurately reflects the current diff:

   • Does the title follow semantic format?
   • Does the description accurately describe all commits?
   • Is the test plan still accurate?
   • Are the release notes complete?

   c. Update if needed:

   gh pr edit <number> --title "new title" --body "new body"
   

   d. Push any new commits (regular push, not force push)

3. If the user chose "Create new branch & PR":

   a. Create a new branch from the current HEAD with a descriptive name based on the user's notes or the staged changes b. Push the new branch to the remote c. Create a new PR following the standards below

Step 3: Link related issues

Search for related issues and link them using Closes #123 or Relates to #123.

Handling problems

Committing automatically runs the linter. Fix any lint/type errors unless they require meaningful code changes—in that case, notify the user:

I can't create/update this PR because [reason]. Would you like me to [suggestion]?

Never force commit or force push.

PR Standards

Title format

Use semantic PR titles (Conventional Commits):

<type>(<scope>): <description>

Types

• feat - New feature
• fix - Bug fix
• docs - Documentation only
• refactor - Code change that neither fixes a bug nor adds a feature
• perf - Performance improvement
• test - Adding or fixing tests
• chore - Maintenance tasks

Scope (optional)

A noun describing the affected area: fix(editor):, feat(sync):, docs(examples):

Examples

• feat(editor): add snap threshold configuration option
• fix(arrows): correct binding behavior with rotated shapes
• docs: update sync documentation

Body template

<description paragraph>

### Change type

- [x] `bugfix` | `improvement` | `feature` | `api` | `other`

### Test plan

1. Step to test...

- [ ] Unit tests
- [ ] End to end tests

### Release notes

- Brief description of changes for users

Description paragraph

Start with: "In order to X, this PR does Y."

• Keep it specific—avoid vague phrases like "improve user experience"
• Link related issues in the first paragraph
• Don't expect readers to also read the linked issue

Change type

• Tick exactly one type with [x]
• Delete unticked items

Test plan

• List manual testing steps if applicable
• Remove the numbered list if changes cannot be manually tested
• Tick checkboxes for included test types

Release notes

• Write brief notes describing user-facing changes
• Use imperative mood: "Add...", "Fix...", "Remove..."
• Omit entirely for internal work with no user-facing impact

API changes section

Include when changes affect api-report.md:

### API changes

- Added `Editor.newMethod()` for X
- Breaking! Removed `Editor.oldMethod()`

PR readiness

• Default to opening the PR as ready for review
• Use a draft PR only when the changed area is failing verification, incomplete, blocked, or otherwise not actually ready for review
• If only unrelated or clearly flaky verification failures remain, still open the PR as ready for review and explicitly call out the residual risk in the PR body

Important

• Never include AI attribution ("Generated with Claude Code", "Co-Authored-By: Claude", etc.) in commits, PR titles, or descriptions
• Never use title case for descriptions—use sentence case
• Never put yourself as co-author of any commits