Workstreams
A workstream is a branch of the spec for one effort: Main plus its own changes, with its tasks, its proposal and its threads, until it completes.
Opening a workstream
Choose Start a workstream in the sidebar switcher, on the Workstreams page or in the command palette, and give it a title of up to 120 characters. It gets the next number of the project, such as WS-3, and becomes your current workstream. Agents open workstreams too, with workstream_open.
You can give it the tracker key of its story, such as KAN-43, and open its first Draft task in the same step. That task becomes your current task.
One workstream per what?
Open one workstream per story or change request. Use one per epic when its stories share artefacts that do not exist yet, so they are not created twice.
The current workstream
Each person has a current workstream per project: the one the app opens when you open the project, and the one the sidebar badges count. Set as current in the switcher changes it; choosing Main clears it. A workstream that completes or is abandoned stops being anyone's current workstream.
The overview
The workstream page holds its title, description, goals and what is out of scope. People edit them directly. An agent's edits to them, with workstream_rename, workstream_editDescription, workstream_editGoals and workstream_editOutOfScope, are staged in the proposal like any other, and accepting them applies the fields nobody changed since.
Completing
Complete a workstream when its work shipped. It needs at least one Done task, no open task and no unrouted change, and its proposal must have nothing pending.
- Empty Draft tasks are abandoned when you complete.
- You can discard the unrouted changes in the same step.
- A publish can ask to complete the workstream when its task lands. If a rule refuses it then, the workstream stays Active and you are notified.
- Tasks that are Done but not yet Delivered are listed first. Completing goes ahead: their work items stay workable.
A completed workstream is read-only; its threads stay readable.
Abandoning
Abandon gives up the workstream with a reason, which is required. Nothing it changed reaches Main. In one step it also abandons its open tasks (and closes their pull requests), discards the open proposal and makes the threads read-only.
Note
People complete and abandon
Completing and abandoning a workstream are a person's acts. Agents open workstreams and stage edits to the overview; in a project with Agent autonomy on, they also complete or abandon one (workstream_complete, workstream_abandon).
Next steps
- Changes and conflicts with Main: what a workstream changes, and how it stays in step with Main.
- Tasks and publishing: ship the changes of a workstream to Main and Git.
- Work items and delivery: build and deploy what a task agreed.