Skip to content

docs: add recommended workflow section to README #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
monkut merged 1 commit into from
Apr 9, 2026
Merged

docs: add recommended workflow section to README #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,37 @@ askcc install [--directory DIR]
| `fix-ci` | Identify failing CI checks on the current PR or branch and implement fixes (`--github-issue-url` optional) |
| `install` | Install bundled skills to `~/.claude/skills` and/or `~/.openclaw/workspace/skills` |

### Recommended Workflow

askcc commands are designed to run sequentially, where each phase produces artifacts (issue sections, labels, project status) that gate and feed the next:

```
prepare → plan → develop → pr-review
```

| Phase | Command | Inputs | Outputs |
|-------|---------|--------|---------|
| **Define** | `prepare` | Raw backlog issue | Acceptance criteria, dependencies, estimate; adds `action:develop` label |
| **Plan** | `plan` | Prepared issue with acceptance criteria | Implementation plan, assignee; finalizes issue description |
| **Build** | `develop` | Planned issue (validated for readiness) | Feature branch, PR linked to issue; swaps label to `action:review` |
| **Verify** | `pr-review` | Issue + linked PR | Definition of Done review, approve or request changes |

Supporting commands can be used at any point:

| Command | When to use |
|---------|-------------|
| `issue-review` | Before `prepare` — review issue quality and suggest improvements |
| `validate` | Before `develop` — check readiness gates without running the agent |
| `explore` | Before `plan` — investigate approaches and trade-offs |
| `diagnose` | Any time — root cause analysis for bug reports |
| `fix-ci` | After `develop` — fix failing CI checks on the PR branch |

**Gating mechanisms:**
- `prepare` adds the `action:develop` label; subsequent commands require an `action:` label prefix
- `develop` runs readiness validation (acceptance criteria, dependencies, assignee, no blocking labels) before starting
- The `needs:decision` label blocks `develop` until resolved
- `develop` swaps `action:develop` → `action:review` and moves the project board status on success

### Options

| Option | Description |
Expand Down
Loading