Skip to content

Commit 0b72817

Browse files
authored
Update contributing.md and pr template to include manual testing instructions (#10286)
1 parent c28fddd commit 0b72817

3 files changed

Lines changed: 21 additions & 9 deletions

File tree

.agents/skills/review-pr-local/SKILL.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
name: review-pr-local
33
specializes: review-pr
4-
description: Repo-specific review guidance for warp-external. Only the categories declared overridable by the core review-pr skill may be specialized here.
4+
description: Repo-specific review guidance for warp. Only the categories declared overridable by the core review-pr skill may be specialized here.
55
---
66

7-
# Repo-specific review guidance for `warp-external`
7+
# Repo-specific review guidance for `warp`
88

99
This file is a companion to the core `review-pr` skill. It does not
1010
redefine the review output schema, severity labels, safety rules, or
@@ -22,13 +22,13 @@ skill marks as overridable.
2222
- In WarpUI code, flag inline `MouseStateHandle::default()` usage during render or event handling. Mouse state handles should be created during construction and then cloned/referenced where needed.
2323
- For user-facing UI changes, mention missing validation only when it is tied to a concrete risk or when the PR changes behavior that should be verified visually.
2424

25-
## UI-impacting changes require visual evidence
25+
## Behavioral or UI-impacting changes require visual evidence
2626

2727
- If the PR changes anything user-visible (UI components, layout, styling, copy in surfaces users see, terminal/Warp app visuals, or other behavior a user can perceive), analyze both `pr_description.txt` and any PR comments available in the workflow context for attached screenshots, GIFs, or videos demonstrating the change end to end.
2828
- Treat markdown image/video embeds (`![...](...)`, `<img ...>`, `<video ...>`), GitHub user-attachment links (e.g. `https://github.com/user-attachments/...`, `https://user-images.githubusercontent.com/...`), Loom links, and similar hosted media as valid evidence.
2929
- The `Screenshots / Videos` section from `.github/pull_request_template.md` being present but empty does not count as evidence.
30-
- If the change is UI-impacting and no screenshots or videos are attached in the description or comments, add an inline or summary-level comment requesting them. Use wording such as: "For faster review, please upload screenshots or a video of the feature working end to end."
31-
- When required visual evidence is missing for a UI-impacting change, set the final recommendation in `summary` to `Request changes`, even if no other blocking issues were found. Call this out explicitly in the `## Verdict` section.
30+
- If the change is behavioral or UI-impacting and no screenshots or videos are attached in the description or comments, and the PR description does not justify why there was no manual testing, add an inline or summary-level comment requesting manual testing and evidence. Use wording such as: "Manual testing is required for changes that can be manually tested. Please include screenshots or a screen recording that show it working end to end, or justify why manual testing is not possible."
31+
- When required visual evidence is missing for a behavioral or UI-impacting change that can be manually tested, set the final recommendation in `summary` to `Request changes`, even if no other blocking issues were found. Call this out explicitly in the `## Verdict` section.
3232
- If the PR is clearly not user-visible (pure refactor, internal tooling, build scripts, server-only logic with no UI surface, tests, docs-only), do not request screenshots or videos.
3333

3434
## User-facing strings

.github/pull_request_template.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,20 @@ Link the GitHub issue this PR addresses. Before opening this PR, please confirm:
88
- [ ] The linked issue is labeled `ready-to-spec` or `ready-to-implement`.
99
- [ ] Where appropriate, screenshots or a short video of the implementation are included below (especially for user-visible or UI changes).
1010

11-
## Screenshots / Videos
12-
<!-- Attach screenshots or a short video demonstrating the change, where appropriate. Remove this section if it is not relevant to your PR. -->
13-
1411
## Testing
1512
<!--
1613
How did you test this change? What automated tests did you add? If you didn't add any new tests, what's your justification for not adding any?
14+
15+
Manual testing is required for changes that can be manually tested, and almost all changes can be manually tested. If your change can be manually tested, please include screenshots or a screen recording that show it working end to end.
16+
17+
You can run the app locally using `./script/run` - see WARP.md for more details on how to get set up.
1718
-->
1819

20+
- [ ] I have manually tested my changes locally with `./script/run`
21+
22+
### Screenshots / Videos
23+
<!-- Attach screenshots or a short video demonstrating the change, where appropriate. Remove this section if it is not relevant to your PR. -->
24+
1925
## Agent Mode
2026
- [ ] Warp Agent Mode - This PR was created via Warp's AI Agent Mode
2127

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,11 +140,17 @@ cargo run # build and run Warp
140140

141141
Tests are required for most code changes:
142142

143+
### Manual Testing
144+
Manual testing is required for changes that can be manually tested, and almost all changes can be manually tested. If your change can be manually tested, please include screenshots or a screen recording that show it working end to end in the PR description.
145+
146+
You can run the app locally using `./script/run` - see [WARP.md](WARP.md) for more details on how to get set up.
147+
148+
### Automated Tests
143149
- **Bug fixes** should include a regression test that would have caught the bug.
144150
- **Algorithmic or non-trivial logic** needs unit tests.
145151
- **User-facing flows** should have end-to-end coverage under [`crates/integration/`](crates/integration/) whenever the behavior can be exercised that way. The bar is high-quality coverage of the changes you ship — with agent-driven development the expectation is more integration tests, not just coverage of P0 paths. If a flow is worth shipping, it's usually worth an integration test.
146152

147-
Run unit tests with `cargo nextest run`. See [WARP.md](WARP.md) for more detail.
153+
Run unit tests with `cargo nextest run`.
148154

149155
## Code Style
150156

0 commit comments

Comments
 (0)