waypoint-codex 0.15.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +200 -62
- package/dist/src/core.js +1 -0
- package/package.json +2 -2
- package/templates/.agents/skills/merge-ready-owner/SKILL.md +15 -3
- package/templates/.agents/skills/work-tracker/SKILL.md +9 -4
- package/templates/.codex/config.toml +0 -4
- package/templates/.gitignore.snippet +0 -1
- package/templates/.waypoint/agent-operating-manual.md +11 -7
- package/templates/managed-agents-block.md +8 -3
- package/templates/.codex/agents/coding-agent.toml +0 -49
package/README.md
CHANGED
|
@@ -1,53 +1,161 @@
|
|
|
1
1
|
# Waypoint
|
|
2
2
|
|
|
3
|
-
Waypoint
|
|
3
|
+
Waypoint makes Codex better by default for real software work.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Codex is already powerful. The problem is that most users still have to teach it
|
|
6
|
+
the same things over and over:
|
|
6
7
|
|
|
7
|
-
-
|
|
8
|
-
-
|
|
8
|
+
- ask better questions before coding
|
|
9
|
+
- plan thoroughly instead of making hidden assumptions
|
|
10
|
+
- follow stronger coding standards
|
|
11
|
+
- review the result seriously before merge
|
|
12
|
+
- verify the work instead of guessing
|
|
13
|
+
- learn from corrections instead of repeating the same mistakes
|
|
9
14
|
|
|
10
|
-
|
|
15
|
+
Waypoint installs those defaults into a repo so you can spend less time
|
|
16
|
+
prompting and more time building.
|
|
11
17
|
|
|
12
|
-
|
|
18
|
+
## Install and upgrade
|
|
13
19
|
|
|
14
|
-
|
|
20
|
+
Waypoint requires Node 20+.
|
|
21
|
+
|
|
22
|
+
Install globally:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install -g waypoint-codex
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Or try it without a global install:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npx waypoint-codex@latest --help
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Inside the repo you want to prepare for Codex:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
waypoint init
|
|
38
|
+
waypoint doctor
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Keep an existing repo up to date:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
waypoint upgrade
|
|
45
|
+
waypoint doctor
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## What gets better
|
|
49
|
+
|
|
50
|
+
With Waypoint, Codex should become better at:
|
|
51
|
+
|
|
52
|
+
- understanding the product and technical context before it starts
|
|
53
|
+
- planning work in enough detail to avoid avoidable mistakes
|
|
54
|
+
- writing code that matches the codebase and holds up in production
|
|
55
|
+
- staying on track during larger or longer-running tasks
|
|
56
|
+
- reviewing and verifying its own work before calling it done
|
|
57
|
+
- improving its own guidance when the user corrects it
|
|
58
|
+
|
|
59
|
+
## Why Waypoint exists
|
|
60
|
+
|
|
61
|
+
Waypoint is for people using Codex on real apps and real codebases, not just
|
|
62
|
+
tiny one-off edits.
|
|
63
|
+
|
|
64
|
+
It exists because most Codex users should not have to manually remember every
|
|
65
|
+
best practice, every guardrail, every planning question, and every review step
|
|
66
|
+
for every task.
|
|
67
|
+
|
|
68
|
+
Waypoint packages that expertise into the repo so Codex starts from a much
|
|
69
|
+
better default.
|
|
70
|
+
|
|
71
|
+
## What Waypoint adds
|
|
72
|
+
|
|
73
|
+
### 1. Better default behavior
|
|
74
|
+
|
|
75
|
+
Waypoint gives Codex stronger repo guidance through the generated contract,
|
|
76
|
+
operating manual, core behavior files, and repo-local instructions.
|
|
77
|
+
|
|
78
|
+
That means the agent is pushed to:
|
|
15
79
|
|
|
16
|
-
|
|
80
|
+
- investigate before narrating status
|
|
81
|
+
- ask better questions about the product, architecture, and constraints
|
|
82
|
+
- explain what it found in a clear way
|
|
83
|
+
- verify what it changed
|
|
84
|
+
- leave the repo clearer than it found it
|
|
17
85
|
|
|
18
|
-
|
|
19
|
-
- strong default collaboration
|
|
20
|
-
- optional structured workflows when the task actually needs them
|
|
86
|
+
### 2. Better planning
|
|
21
87
|
|
|
22
|
-
|
|
88
|
+
Waypoint ships a thorough planning workflow for work that should not start from
|
|
89
|
+
guesswork.
|
|
23
90
|
|
|
24
|
-
|
|
25
|
-
- explain what is happening
|
|
26
|
-
- fix what you can
|
|
27
|
-
- verify it
|
|
28
|
-
- leave the repo clearer than you found it
|
|
91
|
+
That workflow pushes the agent to:
|
|
29
92
|
|
|
30
|
-
|
|
93
|
+
- interview the user until the real requirements are clear
|
|
94
|
+
- produce a detailed plan before implementation
|
|
95
|
+
- challenge that plan with a reviewer agent
|
|
96
|
+
- tighten the plan before coding starts
|
|
31
97
|
|
|
32
|
-
|
|
98
|
+
The goal is simple: fewer assumptions, fewer surprises, and a much better shot
|
|
99
|
+
at one-shot execution.
|
|
33
100
|
|
|
34
|
-
|
|
35
|
-
|
|
101
|
+
### 3. Better code quality
|
|
102
|
+
|
|
103
|
+
Waypoint does not assume Codex will naturally write production-quality code by
|
|
104
|
+
default.
|
|
105
|
+
|
|
106
|
+
It adds guardrails that push the agent toward:
|
|
107
|
+
|
|
108
|
+
- stronger coding standards
|
|
109
|
+
- better fit with the existing codebase
|
|
110
|
+
- fewer lazy shortcuts
|
|
111
|
+
- fewer architecture mistakes
|
|
112
|
+
- fewer duplicated or premature abstractions
|
|
113
|
+
|
|
114
|
+
Reviewer agents and audit workflows add another pass before merge when the work
|
|
115
|
+
needs it.
|
|
116
|
+
|
|
117
|
+
### 4. Better end-to-end execution
|
|
118
|
+
|
|
119
|
+
Waypoint also helps Codex follow through on bigger tasks.
|
|
120
|
+
|
|
121
|
+
It includes workflows for:
|
|
122
|
+
|
|
123
|
+
- long-running task tracking
|
|
124
|
+
- ship-readiness audits
|
|
125
|
+
- merge-ready ownership
|
|
126
|
+
- deliberate review passes before PR or merge
|
|
127
|
+
|
|
128
|
+
This helps the agent keep moving until the work is actually ready, not just
|
|
129
|
+
"probably done."
|
|
130
|
+
|
|
131
|
+
### 5. Self-improvement
|
|
132
|
+
|
|
133
|
+
Waypoint treats user corrections as product input, not just conversation noise.
|
|
134
|
+
|
|
135
|
+
When the user corrects behavior, rules, or workflow, the agent is pushed to
|
|
136
|
+
update the right durable files so the same issue is less likely to happen
|
|
137
|
+
again.
|
|
138
|
+
|
|
139
|
+
That includes:
|
|
140
|
+
|
|
141
|
+
- user-scoped guidance
|
|
142
|
+
- project-scoped guidance
|
|
36
143
|
- repo-local skills
|
|
37
|
-
-
|
|
38
|
-
|
|
144
|
+
- retrospectives that turn friction from the current conversation into lasting
|
|
145
|
+
improvements
|
|
39
146
|
|
|
40
|
-
|
|
147
|
+
### 6. Better continuity
|
|
41
148
|
|
|
42
|
-
|
|
149
|
+
Waypoint gives Codex explicit continuity artifacts so the next session does not
|
|
150
|
+
start half-blind.
|
|
43
151
|
|
|
44
|
-
|
|
45
|
-
- ship-readiness passes
|
|
46
|
-
- trackers
|
|
47
|
-
- retrospectives
|
|
48
|
-
- pre-PR hygiene
|
|
152
|
+
That includes:
|
|
49
153
|
|
|
50
|
-
|
|
154
|
+
- a generated docs index that tells the agent which docs exist and when to read
|
|
155
|
+
them
|
|
156
|
+
- a live workspace file that records what is going on right now
|
|
157
|
+
- a generated recent thread file that carries the most important prior
|
|
158
|
+
conversation context forward
|
|
51
159
|
|
|
52
160
|
## What Waypoint sets up
|
|
53
161
|
|
|
@@ -57,32 +165,43 @@ Waypoint scaffolds a Codex-friendly repo around a few core pieces:
|
|
|
57
165
|
- `.waypoint/WORKSPACE.md` for live operational state
|
|
58
166
|
- `.waypoint/docs/` for long-lived project docs
|
|
59
167
|
- `.waypoint/plans/` for durable plan documents
|
|
60
|
-
- `.waypoint/DOCS_INDEX.md` for docs and plans routing
|
|
168
|
+
- `.waypoint/DOCS_INDEX.md` for docs and plans routing, so the agent knows what
|
|
169
|
+
to read and when
|
|
61
170
|
- `.waypoint/context/` for generated startup context
|
|
62
|
-
- `.waypoint/
|
|
171
|
+
- `.waypoint/context/RECENT_THREAD.md` for compact continuity from the previous
|
|
172
|
+
conversation
|
|
173
|
+
- `.waypoint/track/` for long-running work that truly needs durable progress
|
|
174
|
+
tracking
|
|
63
175
|
- `.agents/skills/` for optional structured workflows
|
|
64
176
|
- `.codex/` for optional reviewer and helper agents
|
|
65
177
|
|
|
66
|
-
|
|
178
|
+
By default, Waypoint routes docs from `.waypoint/docs/` and plans from
|
|
179
|
+
`.waypoint/plans/`.
|
|
180
|
+
If your repo keeps routable docs elsewhere, you can add more explicit roots in
|
|
181
|
+
`.waypoint/config.toml` with `docs_dirs` and `plans_dirs`.
|
|
182
|
+
Waypoint scans each configured root recursively and only includes Markdown files
|
|
183
|
+
with valid Waypoint frontmatter.
|
|
67
184
|
|
|
68
|
-
|
|
69
|
-
- more explicit repo-local state
|
|
70
|
-
- stronger default collaboration
|
|
71
|
-
- investigation before status narration
|
|
72
|
-
- structured workflows that stay in their own tools
|
|
185
|
+
The continuity story matters:
|
|
73
186
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
187
|
+
- `.waypoint/DOCS_INDEX.md` helps the agent find the right docs before work
|
|
188
|
+
- `.waypoint/WORKSPACE.md` helps the next session understand what is in flight
|
|
189
|
+
- `.waypoint/context/RECENT_THREAD.md` helps the agent retain the important
|
|
190
|
+
parts of the previous conversation
|
|
77
191
|
|
|
78
192
|
## Best fit
|
|
79
193
|
|
|
80
194
|
Waypoint is most useful when you want:
|
|
81
195
|
|
|
82
|
-
-
|
|
83
|
-
-
|
|
84
|
-
-
|
|
85
|
-
-
|
|
196
|
+
- a better default Codex workflow in a real repo
|
|
197
|
+
- stronger planning before implementation starts
|
|
198
|
+
- stronger coding standards and review guardrails
|
|
199
|
+
- better follow-through on long tasks
|
|
200
|
+
- a personal workflow that can live in almost any repo without becoming a team
|
|
201
|
+
rollout
|
|
202
|
+
|
|
203
|
+
Waypoint is primarily an individual tool.
|
|
204
|
+
Most of its repo-local state is meant to stay personal and local by default.
|
|
86
205
|
|
|
87
206
|
If you only use Codex for tiny one-off edits, Waypoint is probably unnecessary.
|
|
88
207
|
|
|
@@ -154,7 +273,37 @@ Waypoint ships a strong default skill pack for real coding work:
|
|
|
154
273
|
These are repo-local, so the workflow travels with the project.
|
|
155
274
|
|
|
156
275
|
The important design choice is that they stay out of the always-on voice.
|
|
157
|
-
Each skill
|
|
276
|
+
Each skill exists to improve the result when the task needs more rigor, without
|
|
277
|
+
turning every normal interaction into a heavy process.
|
|
278
|
+
|
|
279
|
+
## How to get full value
|
|
280
|
+
|
|
281
|
+
Installing Waypoint improves Codex's defaults right away, but the full workflow
|
|
282
|
+
is not completely automatic.
|
|
283
|
+
|
|
284
|
+
Some of Waypoint's biggest advantages come from user-invoked skills that should
|
|
285
|
+
be used deliberately when the moment calls for them.
|
|
286
|
+
|
|
287
|
+
The most important ones are:
|
|
288
|
+
|
|
289
|
+
- `code-guide-audit` when you want a code quality pass against your repo's
|
|
290
|
+
standards and working rules
|
|
291
|
+
- `backend-ship-audit` when backend work needs a deeper production-readiness
|
|
292
|
+
pass
|
|
293
|
+
- `frontend-ship-audit` when frontend work needs a deeper product, UX, and ship
|
|
294
|
+
readiness pass
|
|
295
|
+
- `docs-sync` when the implementation changed and the repo docs should be
|
|
296
|
+
brought back in sync
|
|
297
|
+
- `conversation-retrospective` when the conversation exposed friction,
|
|
298
|
+
corrections, or workflow problems that should become durable improvements
|
|
299
|
+
- `merge-ready-owner` when you want the agent to own the task all the way to a
|
|
300
|
+
merge-ready result with stronger autonomy
|
|
301
|
+
|
|
302
|
+
The practical rule is:
|
|
303
|
+
|
|
304
|
+
- install Waypoint for better defaults
|
|
305
|
+
- invoke the higher-rigor skills when you want a stronger planning, audit,
|
|
306
|
+
review, docs, or closeout pass
|
|
158
307
|
|
|
159
308
|
## Reviewer agents
|
|
160
309
|
|
|
@@ -172,24 +321,13 @@ Waypoint is opinionated, but explicit:
|
|
|
172
321
|
|
|
173
322
|
- state lives in files you can inspect
|
|
174
323
|
- docs routing is generated, not guessed from memory
|
|
175
|
-
- the default contract tells the agent to investigate
|
|
324
|
+
- the default contract tells the agent to ask better questions and investigate
|
|
325
|
+
first
|
|
176
326
|
- durable guidance is separated into user-scoped AGENTS, project-scoped AGENTS, live workspace state, project docs, and plan docs
|
|
177
327
|
- visual explanation stays lightweight: Mermaid in chat and screenshots from real UI inspection
|
|
178
328
|
- heavier workflows stay in optional skills
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
Waypoint requires Node 20+.
|
|
183
|
-
|
|
184
|
-
```bash
|
|
185
|
-
npm install -g waypoint-codex
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
Or run it without a global install:
|
|
189
|
-
|
|
190
|
-
```bash
|
|
191
|
-
npx waypoint-codex@latest --help
|
|
192
|
-
```
|
|
329
|
+
- user corrections are supposed to improve the system instead of disappearing
|
|
330
|
+
into chat history
|
|
193
331
|
|
|
194
332
|
## Main commands
|
|
195
333
|
|
package/dist/src/core.js
CHANGED
|
@@ -347,6 +347,7 @@ export function initRepository(projectRoot, options) {
|
|
|
347
347
|
"docs/README.md",
|
|
348
348
|
"docs/code-guide.md",
|
|
349
349
|
"docs/legacy-import",
|
|
350
|
+
".codex/agents/coding-agent.toml",
|
|
350
351
|
".agents/skills/error-audit",
|
|
351
352
|
".agents/skills/observability-audit",
|
|
352
353
|
".agents/skills/ux-states-audit",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "waypoint-codex",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "Codex
|
|
3
|
+
"version": "0.17.0",
|
|
4
|
+
"description": "Make Codex better by default with stronger planning, code quality, reviews, tracking, and repo guidance.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"bin": {
|
|
@@ -36,6 +36,11 @@ When the product surface makes it practical, extend done to include:
|
|
|
36
36
|
|
|
37
37
|
Do not stop at "the code compiles" or "the first push is up."
|
|
38
38
|
|
|
39
|
+
During the loop, keep live execution state current:
|
|
40
|
+
|
|
41
|
+
- update `WORKSPACE.md` as milestones, blockers, verification state, and next steps change
|
|
42
|
+
- if a tracker exists or the work has become tracker-worthy, update the tracker during the work instead of reconstructing it later
|
|
43
|
+
|
|
39
44
|
## Step 1: Reconfirm The Scope And Ownership Mode
|
|
40
45
|
|
|
41
46
|
- Make sure the plan is already approved or the user explicitly said to proceed.
|
|
@@ -64,7 +69,7 @@ For bugs, prefer reproducing the problem first, then fixing it, then proving the
|
|
|
64
69
|
|
|
65
70
|
Use the repo's existing skills and reviewer agents instead of inventing a parallel process.
|
|
66
71
|
|
|
67
|
-
- Use `work-tracker` when the work
|
|
72
|
+
- Use `work-tracker` early when the work becomes non-trivial, multi-step, review-heavy, or checklist-driven enough that `WORKSPACE.md` alone will stop being a good live record.
|
|
68
73
|
- Use `docs-sync` when shipped behavior, routes, contracts, or commands changed materially.
|
|
69
74
|
- Use `pre-pr-hygiene` before pushing or opening/updating a PR when the change surface is substantial.
|
|
70
75
|
- Use `pr-review` once active PR review or automated review has started.
|
|
@@ -75,8 +80,10 @@ If the repo ships reviewer agents under `.codex/agents/`, use them in the closeo
|
|
|
75
80
|
- run `code-reviewer` for every non-trivial implementation slice before declaring the work clear
|
|
76
81
|
- run `code-health-reviewer` when the change is medium or large, especially when it adds structure, duplicates logic, or introduces new abstractions
|
|
77
82
|
- launch them in parallel when both apply
|
|
83
|
+
- use them at meaningful milestones, not only at the very end: after substantial implementation chunks, before opening or materially updating a PR, after fixing substantial findings, and before final closeout
|
|
78
84
|
- treat them as fresh closeout passes, not as optional decoration
|
|
79
|
-
- if
|
|
85
|
+
- if either reviewer finds anything more serious than obvious optional polish, fix those findings, rerun the most relevant verification, and run fresh reviewer passes instead of trusting stale results
|
|
86
|
+
- keep iterating until the remaining reviewer feedback is only nitpicks or none
|
|
80
87
|
|
|
81
88
|
If those reviewer agents are not present in the repo, do the equivalent closeout thinking locally and continue instead of blocking on missing helpers.
|
|
82
89
|
|
|
@@ -96,6 +103,7 @@ If an existing repo-local skill clearly matches the verification surface, use it
|
|
|
96
103
|
- Run builds, lint, migrations, or focused smoke tests when they are part of the real risk surface.
|
|
97
104
|
- Fix failing checks before pushing unless the user explicitly accepts an exception.
|
|
98
105
|
- For user-facing flows, do at least one realistic manual or UI-driven pass beyond pure unit coverage.
|
|
106
|
+
- Update `WORKSPACE.md` and any active tracker with the current verification state before moving on.
|
|
99
107
|
|
|
100
108
|
Do not push a branch that still obviously fails its own touched-surface checks.
|
|
101
109
|
|
|
@@ -110,6 +118,8 @@ When the repo uses PRs:
|
|
|
110
118
|
|
|
111
119
|
If the repo does not use PRs, keep moving through the equivalent review and handoff workflow instead of forcing PR-shaped steps.
|
|
112
120
|
|
|
121
|
+
Before opening or materially updating the PR on non-trivial work, strongly prefer a fresh reviewer-agent pass when those agents are available.
|
|
122
|
+
|
|
113
123
|
## Step 8: Babysit The PR Instead Of Dropping It
|
|
114
124
|
|
|
115
125
|
When the repo uses PRs, CI, or preview environments:
|
|
@@ -130,6 +140,7 @@ Once review starts:
|
|
|
130
140
|
- fix valid findings
|
|
131
141
|
- reply inline where the workflow supports inline reply
|
|
132
142
|
- rerun the relevant verification after review-driven fixes
|
|
143
|
+
- if the fixes were meaningful, run fresh reviewer-agent passes before you call the work clear when those agents are available
|
|
133
144
|
|
|
134
145
|
Do not leave comments unanswered just because the code changed.
|
|
135
146
|
|
|
@@ -161,12 +172,13 @@ Keep the handoff plain and direct. The point of this skill is to reduce the user
|
|
|
161
172
|
## Gotchas
|
|
162
173
|
|
|
163
174
|
- Do not mistake planning approval for permission to stop at implementation; this skill owns the full closeout.
|
|
175
|
+
- Do not let `WORKSPACE.md` or an active tracker fall behind reality while the work is in flight.
|
|
164
176
|
- Do not rely only on automated tests when the risky surface is interactive.
|
|
165
177
|
- Do not let stale previews, staging selectors, old PR branches, or half-deployed environments quietly poison verification.
|
|
166
178
|
- Do not treat CI failures, review comments, or rollout gates as outside the task once the user asked for full ownership.
|
|
167
179
|
- Do not declare success while known meaningful review findings or failing checks still exist.
|
|
168
180
|
- Do not confuse a reusable test harness or scripted UI test with the final walkthrough artifact; the artifact should show the real verified surface when practical.
|
|
169
|
-
- Do not forget the reviewer-agent loop when `code-reviewer` and `code-health-reviewer` are available. They are part of the closeout signal, not an afterthought.
|
|
181
|
+
- Do not forget the reviewer-agent loop when `code-reviewer` and `code-health-reviewer` are available. They are part of the closeout signal, not an afterthought, and serious findings should reopen the fix-and-review cycle.
|
|
170
182
|
|
|
171
183
|
## Keep This Skill Sharp
|
|
172
184
|
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: work-tracker
|
|
3
|
-
description: Create or maintain a durable tracker under `.waypoint/track/` for
|
|
3
|
+
description: Create or maintain a durable tracker under `.waypoint/track/` for any non-trivial workstream that needs ongoing execution state. Use when work has multiple steps, meaningful verification, review follow-ups, milestone checkpoints, or any real chance that `WORKSPACE.md` alone will stop being enough as the work evolves.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Work Tracker
|
|
7
7
|
|
|
8
|
-
Use this skill when the work
|
|
8
|
+
Use this skill when the work has enough moving parts that the next state should not live only in chat or in a few workspace bullets.
|
|
9
9
|
|
|
10
10
|
This skill owns the execution tracker layer:
|
|
11
11
|
|
|
@@ -34,12 +34,15 @@ Before tracking:
|
|
|
34
34
|
|
|
35
35
|
Create or update a tracker when any of these are true:
|
|
36
36
|
|
|
37
|
+
- the work is non-trivial and will unfold across multiple meaningful steps
|
|
37
38
|
- the work will likely span multiple sessions
|
|
38
39
|
- there are many actionable items to implement
|
|
39
40
|
- an audit, QA pass, or review produced a remediation campaign
|
|
40
41
|
- verification requires a substantial checklist
|
|
42
|
+
- the work has milestone checkpoints, PR stages, or repeated fix-and-verify loops
|
|
41
43
|
- `WORKSPACE.md` would become noisy if it carried all the detail
|
|
42
44
|
|
|
45
|
+
When in doubt, prefer creating or updating the tracker for non-trivial work instead of hoping the workspace alone will stay enough.
|
|
43
46
|
Small, single-shot work does not need a tracker.
|
|
44
47
|
|
|
45
48
|
## Step 1: Choose The Tracker File
|
|
@@ -85,7 +88,7 @@ A good tracker usually includes:
|
|
|
85
88
|
- `Decisions`
|
|
86
89
|
- `Notes`
|
|
87
90
|
|
|
88
|
-
Use
|
|
91
|
+
Use `- [ ]` checkboxes when there are many concrete tasks to track. Use status-style entries when the work is better expressed as phase/state updates than as a task list. Use timestamped bullets for materially revised state.
|
|
89
92
|
|
|
90
93
|
## Step 4: Link It From The Workspace
|
|
91
94
|
|
|
@@ -97,8 +100,9 @@ The tracker should answer "what exactly is happening across the whole workstream
|
|
|
97
100
|
## Step 5: Maintain It During Execution
|
|
98
101
|
|
|
99
102
|
- Update `last_updated` whenever you materially change the tracker.
|
|
100
|
-
-
|
|
103
|
+
- Keep task lists or status entries current instead of deleting history. Mark completed checkbox items as `- [x]`, and update status-style entries when the phase or state changes.
|
|
101
104
|
- Add blockers, new tasks, and verification status as the work evolves.
|
|
105
|
+
- Update the tracker during the work, not only at the end. If a milestone, blocker, review round, or verification result changed reality, the tracker should already reflect it.
|
|
102
106
|
- When the workstream finishes, set `status: done` or `status: archived`.
|
|
103
107
|
|
|
104
108
|
Do not let the tracker become fiction. It must match reality.
|
|
@@ -118,6 +122,7 @@ When you create or update a tracker, report:
|
|
|
118
122
|
## Gotchas
|
|
119
123
|
|
|
120
124
|
- Do not create a new tracker if a relevant active tracker already exists for the same workstream.
|
|
125
|
+
- Do not wait until final handoff to start the tracker if the work has already become multi-step, review-heavy, or hard to summarize from memory.
|
|
121
126
|
- Do not let the tracker become fiction. Completed items, blockers, and verification state should match reality.
|
|
122
127
|
- Do not stuff durable architecture or debugging knowledge into the tracker if it belongs in `.waypoint/docs/`.
|
|
123
128
|
- Do not leave `WORKSPACE.md` carrying the full execution log after a tracker exists.
|
|
@@ -9,10 +9,6 @@ max_threads = 24
|
|
|
9
9
|
description = "Read-only background reviewer for post-commit maintainability drift, dead code, duplication, and refactoring opportunities worth fixing."
|
|
10
10
|
config_file = "agents/code-health-reviewer.toml"
|
|
11
11
|
|
|
12
|
-
[agents."coding-agent"]
|
|
13
|
-
description = "Optional workspace-writing implementation helper for bounded coding tasks that should follow the code guide, verify changes, and hand the slice back cleanly."
|
|
14
|
-
config_file = "agents/coding-agent.toml"
|
|
15
|
-
|
|
16
12
|
[agents."code-reviewer"]
|
|
17
13
|
description = "Read-only background reviewer for post-commit bugs, regressions, and integration mistakes."
|
|
18
14
|
config_file = "agents/code-reviewer.toml"
|
|
@@ -57,18 +57,22 @@ If something important lives only in your head or in the chat transcript, the re
|
|
|
57
57
|
- Before making meaningful frontend or backend decisions, inspect the available user-scoped and project-scoped `AGENTS.md` guidance. If the task depends on frontend or backend context that is missing from the project-scoped guidance and routed docs, use the corresponding `*-context-interview` skill to fill that gap instead of guessing.
|
|
58
58
|
- Update the user-scoped `AGENTS.md` when you learn a durable preference, workflow rule, or default that should apply across projects and your environment allows you to edit it.
|
|
59
59
|
- Update the project-scoped repo `AGENTS.md` when you learn durable repo truth, project constraints, or stable project-specific collaboration rules.
|
|
60
|
-
-
|
|
61
|
-
-
|
|
60
|
+
- Treat `.waypoint/WORKSPACE.md` as mandatory live execution state, not end-of-task paperwork.
|
|
61
|
+
- Update `.waypoint/WORKSPACE.md` during the work whenever the active goal, phase, next step, blocker, verification state, or review state materially changes. In multi-topic sections, prefix new or materially revised bullets with a local timestamp like `[2026-03-06 20:10 PST]`.
|
|
62
|
+
- Do not wait until final handoff to update workspace state. If the work took enough effort that the next agent would benefit from a current snapshot, the workspace should already say so.
|
|
63
|
+
- For any non-trivial multi-step work, any work likely to span sessions, any work with a meaningful checklist, or any workstream that has already accumulated review/QA follow-ups, create or update a tracker in `.waypoint/track/`, keep detailed execution state there during the work, and point at it from `## Active Trackers` in `.waypoint/WORKSPACE.md`.
|
|
64
|
+
- If a tracker exists for the workstream, maintain it as the work evolves instead of updating it only at the end.
|
|
62
65
|
- Update `.waypoint/docs/` when durable project knowledge changes, update `.waypoint/plans/` when durable plans change, and refresh each changed routable doc's `last_updated` field.
|
|
63
66
|
- Rebuild `.waypoint/DOCS_INDEX.md` whenever routable docs change.
|
|
64
67
|
- Rebuild `.waypoint/TRACKS_INDEX.md` whenever tracker files change.
|
|
65
|
-
- Keep most work in the main agent. Use skills, trackers,
|
|
68
|
+
- Keep most work in the main agent. Use skills, trackers, and reviewer agents when they clearly add leverage, not as default ceremony.
|
|
66
69
|
- Let skills carry their own invocation guidance. The always-on contract should only keep the high-level rule: use repo-local skills deliberately when they help the current task.
|
|
67
|
-
-
|
|
68
|
-
- When spawning reviewer agents or other
|
|
69
|
-
-
|
|
70
|
+
- Use the repo-local skills and reviewer agents deliberately, but do not underuse them on work that is expensive to get wrong.
|
|
71
|
+
- When spawning reviewer agents or other subagents, explicitly set `fork_context: false` and choose the model/reasoning pair that matches the risk and importance of the second pass.
|
|
72
|
+
- For non-trivial work, strongly prefer reviewer-agent passes between major implementation milestones, before opening or updating a PR, after fixing substantial findings, and before final closeout when the environment allows those agents to run.
|
|
70
73
|
- If you created a PR earlier in the current session and need to push more work, first confirm that PR is still open. If it is closed, create a fresh branch from `origin/main` and open a fresh PR instead of pushing more commits to the old PR branch.
|
|
71
74
|
- Treat reviewer agents as one-shot workers: once a reviewer returns findings, read the result and close it. If another review pass is needed later, spawn a fresh reviewer instead of reusing the same thread.
|
|
75
|
+
- If `code-reviewer` or `code-health-reviewer` surface anything more serious than optional polish, fix the findings, rerun the relevant verification, and launch fresh passes until the remaining feedback is only nitpicks or none.
|
|
72
76
|
- Do not kill long-running subagents or reviewer agents just because they are slow.
|
|
73
77
|
- When waiting on reviewers, subagents, CI, automated review, or external jobs that you deliberately chose to start, wait as long as required. There is no fixed timeout where waiting itself becomes the problem.
|
|
74
78
|
- Never interrupt in-flight work just to force a partial result, salvage something quickly, or avoid making the user wait longer.
|
|
@@ -113,7 +117,6 @@ Do not document every trivial implementation detail. Document the non-obvious, d
|
|
|
113
117
|
|
|
114
118
|
Waypoint scaffolds these focused specialists by default:
|
|
115
119
|
|
|
116
|
-
- `coding-agent` for bounded implementation slices the main agent deliberately wants to hand off because parallelism or context preservation will clearly help
|
|
117
120
|
- `code-reviewer` for correctness and regression review
|
|
118
121
|
- `code-health-reviewer` for maintainability drift
|
|
119
122
|
- `plan-reviewer` to challenge non-trivial implementation plans when an independent second pass would materially improve the result
|
|
@@ -133,6 +136,7 @@ Deliberate closeout review is available when you want a second pass for ship-rea
|
|
|
133
136
|
- If you use it, follow the skill's loop fully: define the reviewable slice, run the needed reviewers, wait for the outputs, fix meaningful findings, and rerun fresh passes when warranted.
|
|
134
137
|
- Treat reviewer agents as one-shot workers. Once a reviewer returns its findings, read the result and close it.
|
|
135
138
|
- Do not widen the scope casually; keep the second pass anchored to the slice you are actually trying to validate.
|
|
139
|
+
- For non-trivial work, the healthy default is to use reviewer passes at meaningful milestones instead of saving all second-pass scrutiny for the very end.
|
|
136
140
|
|
|
137
141
|
## Quality bar
|
|
138
142
|
|
|
@@ -94,13 +94,18 @@ Delivery expectations:
|
|
|
94
94
|
- Only come back before that if you hit a genuine blocker you cannot clear with the codebase, tools, or available context. If that happens, say it plainly and be explicit about what remains unverified.
|
|
95
95
|
|
|
96
96
|
Working rules:
|
|
97
|
-
-
|
|
97
|
+
- Treat `.waypoint/WORKSPACE.md` as a mandatory live execution log, not a closeout chore.
|
|
98
|
+
- Update `.waypoint/WORKSPACE.md` during the work whenever the active goal, current phase, next step, blocker, verification state, or handoff context materially changes.
|
|
99
|
+
- For multi-step work, keep the workspace moving as you move: do not wait until the end of the task to reconstruct what happened.
|
|
100
|
+
- If a tracker exists for the active workstream, update the tracker during the work as well and keep `WORKSPACE.md` pointing at the current tracker state.
|
|
98
101
|
- Update user-scoped `AGENTS.md` when you learn a durable preference, standing rule, or default that should apply across projects and your environment allows you to edit that file
|
|
99
102
|
- Update the project-scoped repo `AGENTS.md` when you learn durable repo truth, project constraints, or stable project-specific collaboration rules
|
|
100
103
|
- Update `.waypoint/docs/` when durable project knowledge changes, update `.waypoint/plans/` when a durable plan changes, and refresh `last_updated` on touched routable docs
|
|
101
|
-
- Keep most work in the main agent. Use repo-local skills, trackers, reviewer agents
|
|
104
|
+
- Keep most work in the main agent. Use repo-local skills, trackers, and reviewer agents when they create clear leverage, not as default ceremony.
|
|
102
105
|
- Let repo-local skills describe their own triggers. The managed block should keep only the high-level rule: use those tools deliberately when they clearly help the task.
|
|
103
|
-
- Use reviewer agents
|
|
106
|
+
- Use reviewer agents proactively at meaningful milestones when the work is non-trivial, risky, user-facing, merge-bound, or otherwise expensive to get wrong.
|
|
107
|
+
- Strong default moments for reviewer-agent passes are: after a meaningful implementation milestone, before opening or updating a PR, after fixing substantial review findings, and before finally calling the work clear.
|
|
108
|
+
- When `code-reviewer` or `code-health-reviewer` find anything more serious than obvious optional polish, fix those findings, rerun the relevant verification, and run fresh review passes until the remaining feedback is only nitpicks or none.
|
|
104
109
|
- Treat `plan-reviewer`, `code-reviewer`, and `code-health-reviewer` as one-shot agents: once a reviewer returns findings, close it; if another pass is needed later, spawn a fresh reviewer instead of reusing the old thread
|
|
105
110
|
- If you created a PR earlier in the current session and need to push more work, first confirm that PR is still open. If it is closed, create a fresh branch from `origin/main` and open a fresh PR instead of pushing more commits to the old PR branch
|
|
106
111
|
- Treat the generated context bundle as required session bootstrap, not optional reference material
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
model = "gpt-5.4-mini"
|
|
2
|
-
model_reasoning_effort = "high"
|
|
3
|
-
sandbox_mode = "workspace-write"
|
|
4
|
-
developer_instructions = """
|
|
5
|
-
Read these files in order before doing anything else:
|
|
6
|
-
1. .waypoint/SOUL.md
|
|
7
|
-
2. .waypoint/agent-operating-manual.md
|
|
8
|
-
3. .waypoint/WORKSPACE.md
|
|
9
|
-
4. .waypoint/context/MANIFEST.md
|
|
10
|
-
5. every file listed in that manifest
|
|
11
|
-
6. .waypoint/docs/code-guide.md
|
|
12
|
-
|
|
13
|
-
After reading them, follow these operating instructions:
|
|
14
|
-
|
|
15
|
-
You are the coding agent. You implement a bounded slice that the main agent deliberately handed to you because delegation is useful here.
|
|
16
|
-
|
|
17
|
-
You are a single-slice execution worker:
|
|
18
|
-
- Finish the specific implementation task you were handed, then stop.
|
|
19
|
-
- Do not silently broaden scope.
|
|
20
|
-
- If the handoff is missing something essential, inspect the repo first and make the narrowest reasonable assumption instead of bouncing the task back immediately.
|
|
21
|
-
|
|
22
|
-
Working rules:
|
|
23
|
-
- Read the files you plan to change before editing them.
|
|
24
|
-
- Read the docs relevant to the area you touch.
|
|
25
|
-
- Follow `.waypoint/docs/code-guide.md` as an active contract, not background reading.
|
|
26
|
-
- Prefer direct, explicit code over speculative abstraction.
|
|
27
|
-
- Keep changes reviewable and easy to explain.
|
|
28
|
-
- When the handed-off slice involves a bug or broken behavior, investigate first and explain the likely cause plainly in your handoff.
|
|
29
|
-
- Do not revert user work you did not create.
|
|
30
|
-
- Do not make unrelated cleanup changes unless they are required to land the slice safely.
|
|
31
|
-
|
|
32
|
-
Implementation expectations:
|
|
33
|
-
- Resolve the exact files and entry points involved in the handed-off slice before editing.
|
|
34
|
-
- Validate inputs, state changes, and integration points at the boundaries you touch.
|
|
35
|
-
- Update tests when behavior changes.
|
|
36
|
-
- Update docs or workspace state when the slice changes durable behavior or repo memory.
|
|
37
|
-
- Run the most relevant verification you can for the owned slice before handing back.
|
|
38
|
-
- If verification fails, keep iterating when you can fix it yourself.
|
|
39
|
-
|
|
40
|
-
Output:
|
|
41
|
-
Return a concise implementation handoff that includes:
|
|
42
|
-
- what you changed
|
|
43
|
-
- files changed
|
|
44
|
-
- verification run and outcome
|
|
45
|
-
- any assumptions, follow-ups, or risks the main agent should know about
|
|
46
|
-
|
|
47
|
-
Do not pretend the slice is verified if you did not run verification.
|
|
48
|
-
Do not use readiness-disclaimer language as the main point of the handoff. If important known issues remain, say what they are, why they matter, and what needs to happen next.
|
|
49
|
-
"""
|