Prompt guidance: distinguish `[STATUS]` lines from `TaskCreate`/`TaskUpdate` calls

未关闭 适合新手
#588 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
72/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
冷清
技术栈
typescript

调研方向

首先,将 wizard/src/lib/agent/commandments.ts 中共享的任务列表指导与 context-mill/llm-prompts/basic-integration/1.0-begin.md 和 context-mill/transformation-config/skills/audit/description.md 中的 Task list 和 Status 部分进行比较。添加一段可复用的说明,明确区分持久的任务阶段与临时的 [STATUS] 活动,并记录何时使用其中一个、两者都使用或两者都不使用。

由索引模型根据 Issue 内容生成。

描述

wizard-pain

Problem

Agent prompts use two progress mechanisms — [STATUS] lines and the TaskCreate/TaskUpdate task list — but when to use which isn't documented in one place. basic-integration uses both; audit deliberately uses [STATUS] + the audit ledger and forbids task calls (audit/description.md: "Do not call TaskCreate / TaskUpdate / TaskGet / TaskList"). We should document the distinction and ship one reusable blurb.

When to use which

TaskCreate / TaskUpdate — the task list (durable plan).
Use when the work has distinct stages the user should follow as a plan with lifecycle. Create the list up front in a single TaskCreate (don't wait for a perfect plan), refine with further TaskCreate/TaskUpdate as understanding sharpens, and drive it with TaskUpdate: in_progress on start, completed on finish. Titles broad and job-oriented — not file/path/symbol specific.

[STATUS] — the live banner (transient activity).
Use for moment-to-moment "Working on …" narration within a stage. Emit a plain-text line prefixed [STATUS] before each phase/sub-step. Cheap, ephemeral, no lifecycle — the harness intercepts it and updates the spinner.

One or both:

  • Multi-stage flow with a task pane → use the task list for the stage backbone and [STATUS] for sub-step narration (basic-integration).
  • Flow whose progress is already tracked another way (e.g. a ledger) → skip task calls entirely, use [STATUS] only (audit).
  • Trivial/single-step work → neither.

Transportable blurb

## Task list

As soon as you have a rough sense of the work, **call `TaskCreate` immediately** — before reading any reference file or starting analysis — so the task pane isn't empty. It's fine if the first list is incomplete: seed it with the high-level items you can infer, then call `TaskCreate` again (or `TaskUpdate` to refine existing items) every time your understanding sharpens. Use `TaskUpdate` to mark an item `in_progress` when you start it and `completed` when you finish. Keeping the list current matters more than getting it right on the first call.

Keep task titles broad and job-oriented — describe the purpose or area of work (e.g. "Planning the migration", "Wiring up auth", "Writing tests"), not the specific files, paths, or symbols involved. Adjust the names to the user's project and context.

## Status

Before beginning each phase or sub-step, emit a plain-text line with the exact prefix `[STATUS]`:

[STATUS] Checking project structure

The harness intercepts these and updates the "Working on …" banner. Use them freely — they are cheap. Use `[STATUS]` for transient activity; use the task list for the durable plan of stages. If progress is already visible through another mechanism (a ledger, etc.), skip the task list and use `[STATUS]` only.

Source references

  • wizard/src/lib/agent/commandments.ts — the shared task-list commandment
  • context-mill/llm-prompts/basic-integration/1.0-begin.md — "Task list" + "Status" sections (uses both)
  • context-mill/transformation-config/skills/audit/description.md — "Live activity — [STATUS]" (uses [STATUS] + ledger, no task calls)
主要语言
TypeScript
星标
204
派生
54
平均合并
1 天 5 小时
30 天内合并 PR
51

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

PostHog/wizard 的其他 Issue

查看 PostHog/wizard 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。