Prepare the branch
Before creating a PR:- Check the selected project device, folder, and branch. Use a feature branch or worktree for the change.
- Review, commit, and push the changes you want reviewed. The Create pull request dialog does not commit or push them for you.
- Check that the project has the intended GitHub remote and that GitHub CLI is installed and authenticated on that computer. See Restore GitHub access.
- Identify the destination branch, such as
main. The dialog’s branch choices come from local branches with configured upstreams; it does not list every branch that exists on GitHub.
Create a draft
1
Open Checks
In Zen’s right panel, open Review, then Checks. Under Git status, choose Create PR.If a PR already appears for the branch, open and inspect that PR before creating another.
2
Check the two branches
In Create pull request, the left branch is the head and the right branch is the base. Check both even when Kisuke fills them in.Keep the head set to the branch whose work you just reviewed and pushed. If you choose another head, inspect that branch’s commits first; changing this selector does not switch the files in your workspace.
3
Describe the change
Enter a Title and a description. The description supports Markdown. The title can initially use the newest commit message; replace it if a broader description would help reviewers.Explain the problem, the resulting behavior, and how you checked it. Include any remaining limitations. Expand the commit preview to check what differs from the base. It displays up to 20 commits, so a long branch needs a fuller review on GitHub or in Git.
4
Choose draft or ready
The dialog initially offers Create draft. Use Create options if you want a regular PR and check the primary button before submitting.A draft lets you put the proposed change on GitHub while you are still preparing it. If a default-branch confirmation appears, recheck the head and base before accepting.
5
Verify the created PR
Wait for the result. On success, the dialog displays PR created with an open link. Open it and verify the repository, head, base, commits, and draft state.Newly edited or unpushed files are not included merely because they are visible in your workspace. Commit and push subsequent updates to the PR’s head branch when they are ready.
Read the PR status
Return to Review → Checks. The PR row can show:
Use More → Refresh to refresh Git status and the branch’s PR lookup. More → Open PR on github.com opens the linked PR when one is available. The branch lookup focuses on open PRs; use GitHub to find older closed or merged PRs.
No PR open is not proof that creation never happened. A lookup or connection failure can leave no PR displayed. After a timeout or failed submission, verify the repository on GitHub before trying again.
Edit the title and description
Once the PR details have loaded, click its title or description in Checks.- Title: press Enter or move focus out of the field to save.
- Description: press Cmd+Enter on macOS or Ctrl+Enter on Windows/Linux, or move focus out of the field to save.
Inspect checks
The Checks section lists reported check names and their statuses. Use its Refresh button for another check lookup. Open the PR on GitHub for logs, review discussions, and the repository’s complete merge requirements. No checks reported on this PR yet does not establish that the change passed validation. Zen’s list displays GitHub check runs; it is not a complete account of every external status or branch rule.Why does the pending total include a finished check?
Why does the pending total include a finished check?
The summary groups checks that are neither passed nor failed into its pending total. Individual rows can still say cancelled, skipped, neutral, or stale. Read the row’s text and inspect GitHub before deciding whether more work is running.
Merge and verify
The Merge action in Checks asks for confirmation and requests a regular merge. It does not offer squash or rebase selection in that row. If your repository requires a different method, use the PR’s GitHub page. Ready to merge describes the displayed merge/review state; it does not mean that every check passed. Before confirming:- Open the PR and check the destination branch, latest commits, reviews, and required checks.
- Confirm that the regular merge method is appropriate.
- Choose Merge, read the confirmation, and wait for the result.
- Verify the PR’s actual state on GitHub, then refresh Zen.
Troubleshoot creation
Push the branch to remote first or No remote branches
Push the branch to remote first or No remote branches
The selected head needs an upstream, and the branch menus only offer local branches that have one. Check the remote and branch tracking on the project device, push the intended branch, then reopen the dialog. A base that exists only as a remote-tracking reference may not appear in this selector.Use your normal Git tools to configure the intended local branch and upstream. Do not add or change a remote merely to make a choice appear without verifying its destination.
No commits to merge
No commits to merge
Check head and base, then confirm that your changes were committed. Unsaved edits, unstaged files, and a branch equal to the base do not supply commits for the preview. The dialog compares the local branch references, so refresh your repository’s remote information when those references may be outdated.
Creation timed out or an existing PR was returned
Creation timed out or an existing PR was returned
Inspect open PRs for the head branch on GitHub. Creation can reuse a detected existing PR; verify its base and contents rather than assuming it matches the new form. Preserve the error and PR URL while investigating. Refreshing or rechecking authentication does not itself retry creation.