182 lines
4.8 KiB
Markdown
182 lines
4.8 KiB
Markdown
---
|
||
id: worklane_kanban
|
||
name: worklane_kanban
|
||
version: 1.0.0
|
||
description: >
|
||
Creates Kanban-style tickets in Worklane using the `worklane add` CLI command.
|
||
Supports listing tickets with `worklane ls`. Both commands support title, description,
|
||
acceptance criteria, implementation plan, tags, due date, owner assignment, and status filtering.
|
||
rendering:
|
||
strategy: cli_args
|
||
join_arrays_with: ","
|
||
omit_empty: true
|
||
---
|
||
|
||
## Outline of the command:
|
||
|
||
```yaml
|
||
command: worklane add
|
||
parameters:
|
||
title:
|
||
type: string
|
||
required: true
|
||
cli_flag: "--title"
|
||
description:
|
||
type: string
|
||
required: false
|
||
cli_flag: "--description"
|
||
acceptance:
|
||
type: array
|
||
required: false
|
||
description: "List of acceptance criteria"
|
||
cli_flag: "--acceptance"
|
||
format: csv
|
||
plan:
|
||
type: array
|
||
required: false
|
||
description: "Step-by-step implementation plan"
|
||
cli_flag: "--plan"
|
||
format: csv
|
||
tags:
|
||
type: array
|
||
required: false
|
||
cli_flag: "--tags"
|
||
format: csv
|
||
due:
|
||
type: string
|
||
required: false
|
||
description: "Due date in YYYY-MM-DD format"
|
||
cli_flag: "--due"
|
||
owner:
|
||
type: string
|
||
required: false
|
||
cli_flag: "--owner"
|
||
|
||
---
|
||
|
||
command: worklane ls
|
||
parameters:
|
||
status:
|
||
type: string
|
||
required: false
|
||
description: "Filter by status (backlog, committed, reviewing, done)"
|
||
cli_flag: "--status"
|
||
```
|
||
|
||
Example adding a ticket:
|
||
```yaml
|
||
input:
|
||
title: "Implement login API"
|
||
description: "Add JWT-based authentication"
|
||
acceptance:
|
||
- "User can log in with email/password"
|
||
- "JWT is returned on success"
|
||
plan:
|
||
- "Create auth controller"
|
||
- "Add JWT middleware"
|
||
- "Write tests"
|
||
tags: ["backend", "auth"]
|
||
due: "2026-06-01"
|
||
owner: "alice"
|
||
output: >
|
||
worklane add --title "Implement login API"
|
||
--description "Add JWT-based authentication"
|
||
--acceptance "User can log in with email/password,JWT is returned on success"
|
||
--plan "Create auth controller,Add JWT middleware,Write tests"
|
||
--tags "backend,auth"
|
||
--due "2026-06-01"
|
||
--owner "alice"
|
||
```
|
||
|
||
Example listing tickets:
|
||
```yaml
|
||
input:
|
||
status: "backlog"
|
||
output: >
|
||
worklane ls --status backlog
|
||
```
|
||
|
||
Example listing all tickets (no filter):
|
||
```yaml
|
||
input: {}
|
||
output: >
|
||
worklane ls
|
||
```
|
||
|
||
## Agent Guidance (IMPORTANT — read before generating tickets)
|
||
|
||
When creating a Worklane ticket, the agent MUST:
|
||
|
||
### 1. Title quality
|
||
|
||
* Keep it short, action-oriented, and outcome-focused
|
||
* Prefer verbs: “Implement”, “Fix”, “Add”, “Refactor”, “Improve”
|
||
* Avoid vague titles like “Update system” or “Fix bug”
|
||
* If possible, specify the subsystem (API, UI, backend, auth, etc.)
|
||
|
||
### 2. Description quality
|
||
|
||
* Explain *what* is being built and *why it matters*
|
||
* Include context or user impact (not implementation details)
|
||
* Keep it 2–4 sentences max unless complexity requires more
|
||
* Avoid duplicating acceptance criteria or implementation steps
|
||
|
||
### 3. Acceptance criteria quality
|
||
|
||
* Must be **testable and verifiable**
|
||
* Each item should describe a *visible or measurable outcome*
|
||
* Use “Given / When / Then” style only if helpful—otherwise keep simple
|
||
* Avoid implementation details (no file names, no internal architecture)
|
||
* Each criterion should represent one atomic expectation
|
||
|
||
#### Good example:
|
||
|
||
* User can log in with valid credentials
|
||
* Invalid credentials return a 401 error
|
||
* Session persists across page refresh
|
||
|
||
#### Bad example:
|
||
|
||
* Implement JWT middleware in auth service ❌ (implementation detail)
|
||
* Add login function ❌ (too vague)
|
||
|
||
### 4. Implementation plan quality
|
||
|
||
* Must be a **step-by-step engineering checklist**
|
||
* Ordered logically from setup → implementation → testing → cleanup
|
||
* Each step should be actionable (start with a verb)
|
||
* Include testing and validation steps explicitly
|
||
* Avoid high-level or vague steps like “build feature”
|
||
|
||
#### Good example:
|
||
|
||
* Create authentication controller
|
||
* Add JWT token generation service
|
||
* Integrate middleware into protected routes
|
||
* Write unit tests for auth flows
|
||
* Add integration tests for login endpoint
|
||
|
||
### 5. General rules
|
||
|
||
* Prefer clarity over completeness
|
||
* Do not repeat information across fields
|
||
* Ensure consistency between description, acceptance criteria, and plan
|
||
* If unsure, choose simpler and more testable phrasing
|
||
|
||
## Using `worklane ls`
|
||
|
||
The `worklane ls` command lists tickets. Use it to check the state of tickets:
|
||
|
||
* `worklane ls` — lists all tickets grouped by status without filtering
|
||
* `worklane ls --status <STATUS>` — filters tickets by status
|
||
|
||
Valid statuses: `backlog`, `committed`, `reviewing`, `done`
|
||
|
||
### Usage patterns
|
||
|
||
When checking ticket status or filtering work, use `worklane ls` rather than reading from file paths directly. This ensures consistent access to ticket data.
|
||
|
||
Example patterns:
|
||
* Check backlog items: `worklane ls --status backlog`
|
||
* View all tickets: `worklane ls`
|