stefano
251148c3ff
## Summary - add repository-wide quality tooling and verification scaffolding, including CI workflows, pnpm workspace setup, ESLint/Prettier/markdown checks, and generated-output verification helpers - reorganize skill sources and generation flow by introducing canonical `_source` variants, generator/manifests, reusable helper abstractions, and shared web-automation/browser utilities - clean up and expand documentation so the root README flows into docs and skill docs, with clearer development, reviewer, installer, and workflow guidance ## Notable changes - docs flow and consistency cleanup across `README.md`, `docs/README.md`, and related docs - new scripts for `check`, docs verification, generated-file verification, shell portability, and safe directory replacement - refactors in Atlassian and web-automation skill runtimes to reduce duplication and centralize reusable code - changelog, development documentation, and CI surface updates ## Test Plan - [ ] `pnpm run check` - [ ] review generated/manifests and skill sync outputs - [ ] smoke-check docs flow from `README.md` to `docs/README.md` to skill docs ## Notes - this branch currently includes tracked `skills/web-automation/shared/node_modules` content that should be reviewed carefully as potentially noisy/accidental committed artifacts Co-authored-by: Stefano Fiorini <stefano.fiorini@firsthorizon.com> Reviewed-on: #1
129 lines
3.7 KiB
Markdown
129 lines
3.7 KiB
Markdown
# Task Plan: [Short Title]
|
|
|
|
> **Variant guardrail (pi):** Required workflow skills (`brainstorming`, `test-driven-development`, `verification-before-completion`, `finishing-a-development-branch`, `using-git-worktrees`) must be available to pi as documented in `docs/PI-SUPERPOWERS.md`. Load the relevant workflow skill before entering its matching phase.
|
|
|
|
## Metadata
|
|
|
|
| Field | Value |
|
|
|-------|-------|
|
|
| Created | YYYY-MM-DD |
|
|
| Slug | YYYY-MM-DD-<slug> |
|
|
| Runtime | pi |
|
|
| Reviewer CLI | codex \| claude \| cursor \| opencode \| pi |
|
|
| Reviewer Model | <model> |
|
|
| MAX_ROUNDS | 10 |
|
|
| Branch Strategy | current-branch \| worktree |
|
|
| Branch Name | <current branch name, or new branch name when worktree is used> |
|
|
| Worktree Path | <absolute path to worktree dir; blank when Branch Strategy = current-branch> |
|
|
| Status | draft |
|
|
|
|
### Status Enum (authoritative)
|
|
|
|
| Value | Meaning |
|
|
|-------|---------|
|
|
| `draft` | Newly created; plan review not yet started |
|
|
| `plan-approved` | Plan review loop returned APPROVED |
|
|
| `implementation-in-progress` | Phase 6 executing |
|
|
| `implementation-approved` | Phase 8 review loop returned APPROVED; awaiting commit |
|
|
| `pushed` | Committed + pushed to remote |
|
|
| `local-only` | Committed locally; user declined push |
|
|
| `aborted-plan-review` | MAX_ROUNDS reached in Phase 5; user aborted |
|
|
| `aborted-impl-review` | MAX_ROUNDS reached in Phase 8; user aborted |
|
|
| `aborted-verification` | Phase 7 retries exhausted; user aborted |
|
|
| `failed` | Hard tooling failure |
|
|
|
|
---
|
|
|
|
## Prompt
|
|
|
|
<!-- Exact user prompt, verbatim. -->
|
|
|
|
## Interpretation
|
|
|
|
<!-- Short restatement of goal + out-of-scope items. -->
|
|
|
|
## Assumptions
|
|
|
|
<!-- Anything we're assuming and needs confirmation. Empty list OK after clarifying questions. -->
|
|
|
|
## Files
|
|
|
|
<!-- Files expected to be created / modified / deleted. Paths are absolute or repo-relative. -->
|
|
|
|
| Action | Path | Why |
|
|
|--------|------|-----|
|
|
| | | |
|
|
|
|
## Approach
|
|
|
|
<!-- 3-10 bullets describing implementation order. -->
|
|
|
|
## TDD Approach
|
|
|
|
<!-- One of:
|
|
(a) **TDD applies** — list the failing test(s) to write first, then implementation, then confirm green.
|
|
(b) **TDD auto-skipped** — reason must be exactly one of:
|
|
- `pure-documentation`
|
|
- `pure-comment-whitespace-rename`
|
|
(c) **TDD user-approved skip** — user explicitly approved skipping TDD for this task.
|
|
Record the approval timestamp (ISO-8601) and the specific reason.
|
|
-->
|
|
|
|
## Acceptance Criteria
|
|
|
|
- [ ] <criterion 1>
|
|
- [ ] <criterion 2>
|
|
|
|
## Verification
|
|
|
|
<!-- Commands to run:
|
|
lint: <cmd>
|
|
typecheck: <cmd>
|
|
tests: <cmd>
|
|
-->
|
|
|
|
## Rollback
|
|
|
|
<!-- How to undo: `git revert <hash>`, or manual steps if the change is not easily reversible. -->
|
|
|
|
---
|
|
|
|
## Runtime State
|
|
|
|
```yaml
|
|
plan_review_round: 0
|
|
implementation_review_round: 0
|
|
CODEX_PLAN_SESSION_ID:
|
|
CODEX_IMPL_SESSION_ID:
|
|
CURSOR_PLAN_SESSION_ID:
|
|
CURSOR_IMPL_SESSION_ID:
|
|
OPENCODE_PLAN_SESSION_ID:
|
|
OPENCODE_IMPL_SESSION_ID:
|
|
last_phase_entered:
|
|
last_round_ts:
|
|
last_scan_outcome_plan:
|
|
last_scan_outcome_impl:
|
|
verification_attempts: 0
|
|
tests_added_count: 0
|
|
tdd_used: false
|
|
```
|
|
|
|
## Review History
|
|
|
|
| Timestamp (ISO-8601) | Loop | Round | Verdict | Summary |
|
|
|----------------------|------|-------|---------|---------|
|
|
| | | | | |
|
|
|
|
## Final Status
|
|
|
|
<!-- Populate the terminal status, commit hash if any, rounds used, TDD usage, tests added, verification attempts, and any revisit notes. -->
|
|
|
|
---
|
|
|
|
## Guardrails (do NOT remove)
|
|
|
|
- This file is the single persistent artifact for `do-task`. Do not split it or delete it on success.
|
|
- `Status` must always match one of the enum values.
|
|
- `Runtime State` is updated by the skill, not by the user.
|
|
- Review History is append-only.
|