Skip to content

Commit a6db57f

Browse files
nhortonclaude
andauthored
docs: add strategy comparison tables and improve new_user onboarding (#382)
- Add review strategy comparison table to README.md, README_REVIEWS.md, and deepreview_reference.md (matching existing table in deepreviews skill) - Move macOS TCC warning in new_user skill to before uv install (the cause) - Add PATH check after uv install with clear exit/reopen guidance - Add Windows uv install instructions - Prefer brew for uv install when available Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 1e8d133 commit a6db57f

4 files changed

Lines changed: 44 additions & 16 deletions

File tree

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -256,9 +256,12 @@ Reviews are `.deepreview` config files placed anywhere in your project, scoped t
256256
**Teams own their own rules.** The security team puts a `.deepreview` in `src/auth/`, the platform team in `infrastructure/`, the docs team in `docs/`. Each file is independent and scoped to its directory.
257257

258258
**Smart file grouping.** Three review strategies control what each reviewer sees:
259-
- **`individual`** — one review per file (best for per-file linting and style checks)
260-
- **`matches_together`** — all matched files reviewed as a group (best for cross-file consistency)
261-
- **`all_changed_files`** — a tripwire: if any sensitive file changes, the reviewer sees _every_ changed file in the branch (best for security audits)
259+
260+
| Strategy | Reviewer sees | Best for |
261+
|----------|--------------|----------|
262+
| `individual` | One file at a time | Per-file linting, style checks |
263+
| `matches_together` | All matched files together | Cross-file consistency, migration safety |
264+
| `all_changed_files` | _Every_ changed file in the branch (tripwire) | Security audits, broad impact analysis |
262265

263266
**Pass caching.** When a review passes, it's marked as clean. It won't re-run until one of its reviewed files actually changes — so reviews stay fast even as your rule set grows.
264267

README_REVIEWS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,12 @@ DeepSchema-generated reviews automatically populate `reference_files` from the s
123123

124124
The `strategy` field controls how matched files are grouped into review tasks.
125125

126+
| Strategy | Reviewer sees | Best for |
127+
|----------|--------------|----------|
128+
| `individual` | One file at a time | Per-file linting, style checks |
129+
| `matches_together` | All matched files together | Cross-file consistency, migration safety |
130+
| `all_changed_files` | _Every_ changed file in the changeset (tripwire) | Security audits, broad impact analysis |
131+
126132
### `individual` — One review per file
127133

128134
Each changed file that matches the rule gets its own review task. The reviewing agent sees only that one file.

plugins/claude/skills/new_user/SKILL.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,19 @@ The DeepWork MCP server requires `uv` (specifically `uvx`). Check if it is insta
2020
command -v uv
2121
```
2222

23-
**If `uv` is NOT found**, install it:
23+
**If `uv` is NOT found**, install it.
2424

25-
- On macOS/Linux:
25+
On macOS, warn the user first:
26+
27+
> **Heads up**: when `uv` installs its Python runtime and resolves packages, macOS may pop up permission dialogs for Photos, Dropbox, or other locations outside this project. This happens because the installer briefly scans system paths. These are safe to **deny** — just click "Don't Allow" on any that appear.
28+
29+
Then install `uv`. Check if `brew` is available first (`command -v brew`):
30+
31+
- If `brew` is available:
32+
```bash
33+
brew install uv
34+
```
35+
- Otherwise, on macOS/Linux:
2636
```bash
2737
curl -LsSf https://astral.sh/uv/install.sh | sh
2838
```
@@ -31,12 +41,24 @@ command -v uv
3141
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
3242
```
3343

34-
After installing, verify it works:
44+
After installing, check if `uv` is on the current PATH:
45+
46+
```bash
47+
command -v uv
48+
```
49+
50+
If `uv` is still not found (the installer adds it to shell config but the current shell doesn't have it yet), tell the user:
51+
52+
> `uv` was installed but isn't available in this shell session yet. Please exit Claude (type `/exit`), close this terminal, open a new terminal in the same directory, and run `claude -c` to resume where we left off.
53+
54+
Stop here — do not proceed. The user will come back in a new session.
55+
56+
If `uv` is found, verify it works:
3557
```bash
3658
uv --version
3759
```
3860

39-
If `uv` was just installed, set `UV_WAS_INSTALLED=true` (you will need this later).
61+
Set `UV_WAS_INSTALLED=true` (you will need this later).
4062

4163
#### 0b. Reload if `uv` was just installed
4264

@@ -64,12 +86,6 @@ Call `get_workflows` (using the `mcp__plugin_deepwork_deepwork__get_workflows` t
6486
6587
Stop the onboarding if the server is not reachable — continuing without it will just produce more confusing errors.
6688

67-
#### 0e. macOS note (macOS only)
68-
69-
If the platform is macOS, briefly mention:
70-
71-
> **Heads up**: during reviews or workflows that scan files, macOS may pop up permission dialogs for Photos, Dropbox, or other locations outside this project. These are safe to **deny** — DeepWork only needs access to your project directory and the review will still complete fine.
72-
7389
### 1. GitHub star (optional)
7490

7591
Check if the `gh` CLI is installed by running `which gh`.

src/deepwork/standard_jobs/deepwork_reviews/deepreview_reference.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,12 @@ rule_name:
2929
rules (e.g. `__pycache__/`, `node_modules/`, `.env`) are excluded automatically,
3030
so they don't need to be listed here.
3131
- **strategy**: How to batch reviews:
32-
- `individual`: One review per matched file
33-
- `matches_together`: All matched files reviewed together
34-
- `all_changed_files`: All changed files (not just matched ones) reviewed together
32+
33+
| Strategy | Reviewer sees | Best for |
34+
|----------|--------------|----------|
35+
| `individual` | One file at a time | Per-file linting, style checks |
36+
| `matches_together` | All matched files together | Cross-file consistency, migration safety |
37+
| `all_changed_files` | _Every_ changed file (tripwire) | Security audits, broad impact analysis |
3538
- **additional_context.unchanged_matching_files**: When true, the reviewer gets files
3639
matching include patterns even if they didn't change in this PR. Critical for
3740
document freshness checks — lets the reviewer see the doc even when only source

0 commit comments

Comments
 (0)