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
119 lines
2.2 KiB
Markdown
119 lines
2.2 KiB
Markdown
# [Plan Title]
|
|
|
|
## Overview
|
|
|
|
- **Goal:** [One sentence describing the end state]
|
|
- **Created:** YYYY-MM-DD
|
|
- **Status:** In Progress | Complete
|
|
|
|
## Context
|
|
|
|
### Requirements
|
|
|
|
[Gathered requirements from user questions]
|
|
|
|
### Constraints
|
|
|
|
[Technical, business, or timeline constraints]
|
|
|
|
### Success Criteria
|
|
|
|
[How we know this is complete]
|
|
|
|
## Architecture
|
|
|
|
### Design Decisions
|
|
|
|
[Key architectural choices and rationale]
|
|
|
|
### Component Relationships
|
|
|
|
[How pieces fit together]
|
|
|
|
### Data Flow
|
|
|
|
[How data moves through the system]
|
|
|
|
## Milestones
|
|
|
|
### M1: [Name]
|
|
|
|
**Description:** [What this milestone achieves]
|
|
|
|
**Acceptance Criteria:**
|
|
|
|
- [ ] [Criterion 1]
|
|
- [ ] [Criterion 2]
|
|
|
|
**Stories:** S-101, S-102, S-103...
|
|
|
|
**Milestone Completion Rule (MANDATORY):**
|
|
|
|
- Run lint/typecheck/tests for changed files.
|
|
- Commit locally (DO NOT push).
|
|
- Stop and ask user for feedback.
|
|
- Apply feedback, re-check changed files, commit again.
|
|
- Move to next milestone only after user approval.
|
|
|
|
---
|
|
|
|
### M2: [Name]
|
|
|
|
**Description:** [What this milestone achieves]
|
|
|
|
**Acceptance Criteria:**
|
|
|
|
- [ ] [Criterion 1]
|
|
- [ ] [Criterion 2]
|
|
|
|
**Stories:** S-201, S-202, S-203...
|
|
|
|
**Milestone Completion Rule (MANDATORY):**
|
|
|
|
- Run lint/typecheck/tests for changed files.
|
|
- Commit locally (DO NOT push).
|
|
- Stop and ask user for feedback.
|
|
- Apply feedback, re-check changed files, commit again.
|
|
- Move to next milestone only after user approval.
|
|
|
|
---
|
|
|
|
## Technical Specifications
|
|
|
|
### Types & Interfaces
|
|
|
|
```typescript
|
|
// Key type definitions
|
|
```
|
|
|
|
### API Contracts
|
|
|
|
```typescript
|
|
// Endpoint signatures, request/response shapes
|
|
```
|
|
|
|
### Constants & Enums
|
|
|
|
```typescript
|
|
// Shared constants
|
|
```
|
|
|
|
## Files Inventory
|
|
|
|
| File | Purpose | Milestone |
|
|
|------|---------|-----------|
|
|
| `path/to/file.ts` | [What it does] | M1 |
|
|
| `path/to/other.ts` | [What it does] | M2 |
|
|
|
|
---
|
|
|
|
## Related Plan Files
|
|
|
|
This file is part of the plan folder under `ai_plan/`:
|
|
|
|
- `original-plan.md` - Original approved plan (reference for original intent)
|
|
- `final-transcript.md` - Final planning transcript (reference for rationale/context)
|
|
- `milestone-plan.md` - This file (full specification)
|
|
- `story-tracker.md` - Status tracking (must be kept up to date)
|
|
- `continuation-runbook.md` - Resume/execution context (read first)
|