A typical journey
1
Connect GitHub
Only needed once. See Create a pull request.
2
Create PR
Your change is on its own branch. To open a pull request, press the pill.
3
Checks Running
Your team’s automated checks are running on the pull request.
4
Ready to Merge
Checks passed. Pressing opens the pull request on GitHub. Your team decides who merges. Often that’s an engineer.
5
Merged
Your change is in the codebase.
Every state
Hover over the pill to see your branch name, how far ahead or behind main it is, and when it was last checked. It checks again after every agent turn, whenever you come back to the window, and every few minutes.
Choosing the default action
Some states have a menu next to the label, headed Choose the default action. Choosing an option runs it straight away, and the pill remembers it for next time.- Create PR or Push to Main, for a branch with no pull request. The default is Create PR.
- Open in browser or Merge, for a pull request that’s ready. The default is Open in browser. If GitHub won’t let you merge yet, for example because a review is required, the pill opens the browser either way.
- Upload Changes, when checks failed and you have changes that aren’t on GitHub yet.