Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 2.03 KB

README.md

File metadata and controls

45 lines (36 loc) · 2.03 KB

Worked planning examples

These directories contain plans, not runnable authentication, payment, or companion applications. Validation commands describe checks in the imagined consumer project; those application tests are not included here. Do not implement example work items in the APS repository.

Example Plan root Demonstrates
User authentication examples/user-auth module boundaries, dependencies, design and action plan
OpenCode companion examples/opencode-companion multi-module product planning
Team payments examples/team-payments multiple owners and crosscutting launch concern
Nested monorepo examples/monorepo-nested/plans federated root and child plan trees

From the repository root, choose your native shell.

Windows PowerShell 5.1 / PowerShell 7, after building:

$Aps = (Resolve-Path -LiteralPath '.\cli\target\debug\aps.exe').Path
& $Aps lint examples
if ($LASTEXITCODE -ne 0) { throw 'Example lint failed' }
& $Aps next --plans examples/user-auth
if ($LASTEXITCODE -ne 0) { throw 'Example selection failed' }
& $Aps next --plans examples/team-payments
if ($LASTEXITCODE -ne 0) { throw 'Team example selection failed' }

macOS / Linux (bash):

./bin/aps lint examples
./cli/target/debug/aps next --plans examples/user-auth
./cli/target/debug/aps next --plans examples/team-payments

Build first using CONTRIBUTING. Lint may report review-age or missing-review warnings: example dates are illustrative history, not a promise of current project review. Do not alter them simply to hide warnings.

For start/complete, copy the plan into a temporary directory first and follow the disposable walkthrough. Keep example state transitions separate from real delivery claims. Never run validation commands from untrusted plans without reviewing what they execute.