// Create a pull request in the warp repository for the current branch. Use when the user mentions opening a PR, creating a pull request, submitting changes for review, or preparing code for merge.
| name | create-pr |
| description | Create a pull request in the warp repository for the current branch. Use when the user mentions opening a PR, creating a pull request, submitting changes for review, or preparing code for merge. |
This guide covers best practices for creating pull requests in the warp repository, including merging master, running presubmit checks, linking Linear tasks, ensuring appropriate test coverage, and structuring your PR for effective review.
fix-errors - Fix presubmit failures (formatting, linting, tests) before opening PRwarp-integration-test - Add or update integration coverage for user-visible flows, regressions, and P0 use casesadd-feature-flag - Gate changes behind feature flagsAlways merge master into your feature branch before starting the review process.
git fetch origin
git merge origin/master
Resolve any merge conflicts locally before opening the PR.
If the PR includes code changes, run the relevant presubmit checks before opening or updating it:
./script/presubmit
./script/presubmit runs:
cargo fmt - Code formattingcargo clippy - Linting with all warnings as errorscargo fmt or cargo clippy just to open or update the PR.If presubmit fails for a code-changing PR, use the fix-errors skill to resolve issues.
You must run cargo fmt and cargo clippy before:
Before creating a PR, review what changes you're about to submit:
# View commits in your branch (comparing against base branch)
git --no-pager log <base-branch>..HEAD --oneline
# View file statistics for changes
git --no-pager diff <base-branch>...HEAD --stat
# View full diff
git --no-pager diff <base-branch>...HEAD
This helps you:
When possible, PRs should be associated with a Linear task. Use the Linear MCP tool (if available) to find corresponding issues.
Branch naming convention:
Remote branches should be prefixed with your name (e.g., zheng/feature, alice/fix-bug).
How to link PRs to Linear:
Include the issue ID in the PR title (e.g., [WARP-1234] Add new feature). Do this before creating the PR for automatic linking.
Use the PR template at .github/pull_request_template.md when opening PRs.
Add changelog entries when appropriate using the format at the bottom of the PR template. Some examples:
CLI workflow:
Check if PR exists for current branch:
gh pr view --json number,url
Exit code 0 if PR exists, 1 if not.
Create a new PR:
# With title and body
gh pr create --title "Title" --body "Description" --draft
# Auto-fill from commits
gh pr create --fill --draft
# Use PR template file
gh pr create --body-file .github/pull_request_template.md --title "Title" --draft
Key flags: --draft / -d, --fill / -f, --body-file / -F, --web / -w
Update an existing PR:
gh pr edit --title "New title" --body "New body"
gh pr edit --add-reviewer username --add-label bug
Mark PR ready for review:
gh pr ready
When committing changes or creating a PR, include attribution at the end of every commit message or PR description:
Co-Authored-By: Warp <agent@warp.dev>
All bug fixes should be accompanied by a regression test. This helps prevent re-breaking something that was already broken once.
The test should:
Code with non-trivial logic should have unit tests to validate functionality:
Examples of what needs unit tests:
SumTree)Not required for:
Follow the repository's local testing conventions for guidance on writing unit tests.
All UI components (implementations of View) should have a simple unit test to validate that they can be laid out without a panic.
This provides high-level coverage over rendering "safety" (though not "correctness"):
#[test]
fn test_component_can_layout() {
use warpui::App;
use warp::test_util::{terminal::initialize_app_for_terminal_view, add_window_with_terminal};
App::test((), |mut app| async move {
initialize_app_for_terminal_view(&mut app);
let term = add_window_with_terminal(&mut app, None);
// Render the component - should not panic
term.update(&mut app, |view, ctx| {
// Create and layout your component
});
})
}
If the PR changes a user-visible flow, fixes an end-to-end regression, or otherwise looks like it would benefit from integration coverage, use the ask_user_question tool before creating or updating the PR to ask whether the user wants an integration test added as part of the work.
Prefer a direct choice such as:
Yes, add an integration test before creating the PRNo, continue without an integration testIf the user chooses to add one, use the warp-integration-test skill.
All "P0 use cases" require an integration test that covers the behavior/flow in question.
A "P0 use case" is defined as: Any behavior of the application that, if broken, warrants an out-of-band release.
Integration tests should:
integration/ directoryUse the warp-integration-test skill for implementation details, test registration steps, and validation workflow.
Your PR summary under the "Description" section should include:
cargo fmt/cargo clippy (and other relevant checks); for documentation-only changes, this is not required.add-feature-flag skill)Run a model-diverse subagent council to investigate the same problem from multiple perspectives, compare findings, and produce a final recommendation. Use this skill whenever the user asks for a council, second opinions, multiple agents/models to evaluate one question, parallel investigation, red-team/blue-team comparison, or help deciding between competing technical approaches.
Launch Oz cloud agents with computer use to reproduce UI-focused bug reports, capture visual evidence, and report reproduction findings. Use when investigating a specific interactive or visual bug from an issue, ticket, support report, or prompt.
Review a pull request diff and write structured feedback to review.json for the workflow to publish. Use when reviewing a checked-out PR from local artifacts like pr_diff.txt and pr_description.txt and producing machine-readable review output instead of posting directly to GitHub.
Generate a static interactive D3 walkthrough of a pull request. Use when the user wants a zoomable PR map, graph/canvas PR orientation, or alternate visualization of PR system components, data flow, code dependencies, and user actions.
Guides creation, revision, and review of Warp- or Oz-branded assets. Use when working on launch pages, docs, HTML/CSS components, UI mockups, prompts, social assets, copy, presentations, or any other branded deliverable that should look and sound unmistakably Warp or Oz.
Implement an approved feature from PRODUCT.md and TECH.md, keeping specs and code aligned in the same PR as implementation evolves. Use after the product and tech specs are approved and the next step is building the feature.