durable-context 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +24 -0
- package/bin/durable-context.js +62 -0
- package/lib/installer.js +553 -0
- package/package.json +31 -0
- package/template/.agents/skills/README.md +6 -0
- package/template/.agents/skills/dive-into-plan/SKILL.md +27 -0
- package/template/.agents/skills/plan-with-context/SKILL.md +27 -0
- package/template/AGENTS.md +17 -0
- package/template/context/README.md +24 -0
- package/template/context/_templates/initiative/README.md +29 -0
- package/template/context/_templates/initiative/architecture.md +44 -0
- package/template/context/_templates/initiative/backlog.md +23 -0
- package/template/context/_templates/initiative/brief.html +56 -0
- package/template/context/_templates/initiative/decisions/ADR-0000-template.md +34 -0
- package/template/context/_templates/initiative/delivery.md +45 -0
- package/template/context/_templates/initiative/infrastructure.md +41 -0
- package/template/context/_templates/initiative/interface.md +41 -0
- package/template/context/_templates/initiative/operations.md +47 -0
- package/template/context/_templates/initiative/plan.md +23 -0
- package/template/context/_templates/initiative/release-doc-notes.md +34 -0
- package/template/context/_templates/initiative/spec.md +35 -0
- package/template/context/_templates/initiative/testing.md +45 -0
- package/template/context/initiatives/.gitkeep +0 -0
- package/template/context/project-profile.md +67 -0
- package/template/decisions/0000-template.md +38 -0
- package/template/decisions/README.md +38 -0
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: dive-into-plan
|
|
3
|
+
description: Interrogate a settled initiative plan for gaps, distribute into per-concern docs, and promote accepted decisions into decisions/. Use ONLY when the human explicitly invokes it ("dive into the plan", "distribute the plan"). Do not trigger automatically.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Dive Into Plan
|
|
7
|
+
|
|
8
|
+
Second half of durable planning, after `plan-with-context`. Requires a settled `plan.md`.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
|
|
12
|
+
1. Read initiative `README.md`, `plan.md`, and `context/project-profile.md` when it exists.
|
|
13
|
+
2. **Interrogate** — ask pointed questions for surfaces the plan skipped (tests, e2e, IaC, CI/CD, config, ops, security, migration, reference impact). Record answers in `plan.md`; note deferred surfaces with reason.
|
|
14
|
+
3. **Distribute** — move settled truth from `plan.md` into initiative files (see templates under `context/_templates/initiative/` for each file's role):
|
|
15
|
+
`spec.md`, `interface.md`, `architecture.md`, `testing.md`, `delivery.md`, `infrastructure.md`, `operations.md` (only when actionable), `backlog.md`, `release-doc-notes.md`. Mark N/A files explicitly.
|
|
16
|
+
4. **Promote decisions** — for each accepted architecture/design choice: next `NNNN` in `decisions/` from `0000-template.md`, status Accepted, index row in `decisions/README.md`, origin link to initiative. Mark superseded decisions; never delete history.
|
|
17
|
+
5. Update initiative `README.md` (status, decisions, implementation state).
|
|
18
|
+
|
|
19
|
+
## Boundary
|
|
20
|
+
|
|
21
|
+
Do not edit `reference/`. Capture future reference impact in `release-doc-notes.md` only.
|
|
22
|
+
|
|
23
|
+
## Done when
|
|
24
|
+
|
|
25
|
+
- Applicable surfaces grilled; answers in `plan.md`.
|
|
26
|
+
- Settled truth not living only in `plan.md`.
|
|
27
|
+
- Accepted decisions in repo-wide `decisions/` log.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: plan-with-context
|
|
3
|
+
description: Draft a durable plan in an initiative plan.md covering the full change surface. Use ONLY when the human explicitly invokes it ("plan with context", "plan with durable context", "durable plan"). Do not trigger for ordinary planning or small tasks.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Plan With Context
|
|
7
|
+
|
|
8
|
+
Invocation-only. Produces `plan.md` for a later `dive-into-plan` pass.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
|
|
12
|
+
1. Read nearest `AGENTS.md` and `context/project-profile.md` when it exists.
|
|
13
|
+
2. Find or create `context/initiatives/<slug>/` (copy `context/_templates/initiative/`). Update `README.md`, then work in `plan.md`. Skip initiatives for tiny fixes.
|
|
14
|
+
3. Draft in `plan.md`: alignment, options, open questions. For each applicable surface, plan the work or mark N/A with reason:
|
|
15
|
+
- Application code · unit/integration tests · e2e · IaC · CI/CD · config/secrets (names only) · observability/rollback · security/data · reference impact
|
|
16
|
+
4. Ground items in real repo tooling (profile or direct inspection). Do not guess.
|
|
17
|
+
5. Iterate with the human until direction is settled. Do not distribute yet.
|
|
18
|
+
|
|
19
|
+
## Handoff
|
|
20
|
+
|
|
21
|
+
When settled, invoke `dive-into-plan`.
|
|
22
|
+
|
|
23
|
+
## Done when
|
|
24
|
+
|
|
25
|
+
- Initiative exists (or reason given why not).
|
|
26
|
+
- `plan.md` covers every applicable surface.
|
|
27
|
+
- Open questions visible; settled truth not frozen in `plan.md` alone.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Agent Guidance - PROJECT_NAME
|
|
2
|
+
|
|
3
|
+
Area-specific `AGENTS.md` files layer on top of this one.
|
|
4
|
+
|
|
5
|
+
<!-- durable-context:start -->
|
|
6
|
+
## Durable Context
|
|
7
|
+
|
|
8
|
+
Working context under [`context/`](context/); durable decisions under [`decisions/`](decisions/).
|
|
9
|
+
Initiatives under [`context/initiatives/`](context/initiatives/) are disposable; promote accepted decisions to [`decisions/`](decisions/).
|
|
10
|
+
|
|
11
|
+
Invocation-only skills — ask by name:
|
|
12
|
+
|
|
13
|
+
- [`plan-with-context`](.agents/skills/plan-with-context/SKILL.md) — draft a plan in `plan.md`.
|
|
14
|
+
- [`dive-into-plan`](.agents/skills/dive-into-plan/SKILL.md) — interrogate gaps, distribute into per-concern docs, promote to [`decisions/`](decisions/).
|
|
15
|
+
|
|
16
|
+
[`context/project-profile.md`](context/project-profile.md) — repo-wide stack, commands, and test facts when populated.
|
|
17
|
+
<!-- durable-context:end -->
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# context/
|
|
2
|
+
|
|
3
|
+
Working bench for PROJECT_NAME — disposable planning context for work in progress.
|
|
4
|
+
|
|
5
|
+
Persists elsewhere: [`../decisions/`](../decisions/) (durable log); `reference/` if reference-docs is installed.
|
|
6
|
+
|
|
7
|
+
## Start Here
|
|
8
|
+
|
|
9
|
+
- `initiatives/` — one folder per piece of work
|
|
10
|
+
- `project-profile.md` — repo-wide stack, commands, tests, delivery (when populated)
|
|
11
|
+
- `_templates/initiative/` — copy to start a new initiative
|
|
12
|
+
|
|
13
|
+
## Flow
|
|
14
|
+
|
|
15
|
+
```text
|
|
16
|
+
plan-with-context -> initiatives/<slug>/plan.md
|
|
17
|
+
dive-into-plan -> per-concern docs + ../decisions/
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
1. Copy `_templates/initiative/` to `initiatives/<slug>/`.
|
|
21
|
+
2. Invoke `plan-with-context` to draft `plan.md`.
|
|
22
|
+
3. When settled, invoke `dive-into-plan` to distribute and promote decisions.
|
|
23
|
+
|
|
24
|
+
Settled truth must not live only in `plan.md`. Do not edit `reference/` from here — use `release-doc-notes.md` for future reference impact.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Initiative Title
|
|
2
|
+
|
|
3
|
+
Status: Draft
|
|
4
|
+
Primary area: TBD
|
|
5
|
+
Started: YYYY-MM-DD
|
|
6
|
+
|
|
7
|
+
## Summary
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## Touched Areas
|
|
12
|
+
|
|
13
|
+
-
|
|
14
|
+
|
|
15
|
+
## Decisions
|
|
16
|
+
|
|
17
|
+
Promote accepted decisions to repo-wide [`decisions/`](../../../decisions/).
|
|
18
|
+
|
|
19
|
+
- None yet.
|
|
20
|
+
|
|
21
|
+
## Open Questions
|
|
22
|
+
|
|
23
|
+
-
|
|
24
|
+
|
|
25
|
+
## Implementation Status
|
|
26
|
+
|
|
27
|
+
- Not started.
|
|
28
|
+
|
|
29
|
+
Per-concern docs (`spec.md`, `architecture.md`, etc.) — see templates in this folder. Use `plan-with-context` then `dive-into-plan`.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Architecture
|
|
2
|
+
|
|
3
|
+
## Context
|
|
4
|
+
|
|
5
|
+
Describe the internal shape of the solution and the existing boundaries this
|
|
6
|
+
initiative must respect.
|
|
7
|
+
|
|
8
|
+
## Components
|
|
9
|
+
|
|
10
|
+
| Component | Responsibility |
|
|
11
|
+
| --- | --- |
|
|
12
|
+
| TBD | TBD |
|
|
13
|
+
|
|
14
|
+
## Flow
|
|
15
|
+
|
|
16
|
+
Use Mermaid when the relationship between moving parts is easier to show than
|
|
17
|
+
explain. Mermaid is valuable here because it stays readable as Markdown for
|
|
18
|
+
agents while rendering as a visible diagram for humans.
|
|
19
|
+
|
|
20
|
+
```mermaid
|
|
21
|
+
flowchart LR
|
|
22
|
+
User[User or caller] -->|request| Entry[Entry point]
|
|
23
|
+
Entry -->|uses| Service[Service]
|
|
24
|
+
Service -->|reads/writes| Store[(Store)]
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Data And Contracts
|
|
28
|
+
|
|
29
|
+
Describe entities, DTOs, events, messages, config, migrations, or external
|
|
30
|
+
contracts affected by the initiative.
|
|
31
|
+
|
|
32
|
+
## Boundaries
|
|
33
|
+
|
|
34
|
+
Describe ownership boundaries, shared layers, external dependencies, and
|
|
35
|
+
what this initiative must not take over.
|
|
36
|
+
|
|
37
|
+
## Security And Compliance
|
|
38
|
+
|
|
39
|
+
Capture authentication, authorization, data residency, audit, privacy,
|
|
40
|
+
secret handling, and abuse cases.
|
|
41
|
+
|
|
42
|
+
## Test Strategy
|
|
43
|
+
|
|
44
|
+
List the tests or verification paths needed for confidence.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Backlog
|
|
2
|
+
|
|
3
|
+
## Status Legend
|
|
4
|
+
|
|
5
|
+
- `Todo`
|
|
6
|
+
- `In Progress`
|
|
7
|
+
- `Blocked`
|
|
8
|
+
- `Done`
|
|
9
|
+
- `Deferred`
|
|
10
|
+
|
|
11
|
+
## Work Items
|
|
12
|
+
|
|
13
|
+
| Status | Item | Area | Notes |
|
|
14
|
+
| --- | --- | --- | --- |
|
|
15
|
+
| Todo | Define first slice | TBD | TBD |
|
|
16
|
+
|
|
17
|
+
## Deferred
|
|
18
|
+
|
|
19
|
+
Use this section for work deferred within this initiative. If a deferred item
|
|
20
|
+
is significant enough to track on its own, start a separate initiative for it
|
|
21
|
+
under `context/initiatives/`.
|
|
22
|
+
|
|
23
|
+
- None yet.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>Initiative Brief</title>
|
|
7
|
+
<style>
|
|
8
|
+
body {
|
|
9
|
+
font-family: Arial, sans-serif;
|
|
10
|
+
margin: 2rem;
|
|
11
|
+
line-height: 1.5;
|
|
12
|
+
color: #1f2933;
|
|
13
|
+
background: #ffffff;
|
|
14
|
+
}
|
|
15
|
+
main {
|
|
16
|
+
max-width: 960px;
|
|
17
|
+
margin: 0 auto;
|
|
18
|
+
}
|
|
19
|
+
h1, h2 {
|
|
20
|
+
line-height: 1.2;
|
|
21
|
+
}
|
|
22
|
+
table {
|
|
23
|
+
border-collapse: collapse;
|
|
24
|
+
width: 100%;
|
|
25
|
+
}
|
|
26
|
+
th, td {
|
|
27
|
+
border: 1px solid #d5dce3;
|
|
28
|
+
padding: 0.5rem;
|
|
29
|
+
text-align: left;
|
|
30
|
+
vertical-align: top;
|
|
31
|
+
}
|
|
32
|
+
</style>
|
|
33
|
+
</head>
|
|
34
|
+
<body>
|
|
35
|
+
<main>
|
|
36
|
+
<h1>Initiative Brief</h1>
|
|
37
|
+
<p>Use this optional page when a concise human-readable summary is useful.</p>
|
|
38
|
+
|
|
39
|
+
<h2>Outcome</h2>
|
|
40
|
+
<p>TBD</p>
|
|
41
|
+
|
|
42
|
+
<h2>Scope</h2>
|
|
43
|
+
<table>
|
|
44
|
+
<tr>
|
|
45
|
+
<th>In</th>
|
|
46
|
+
<th>Out</th>
|
|
47
|
+
</tr>
|
|
48
|
+
<tr>
|
|
49
|
+
<td>TBD</td>
|
|
50
|
+
<td>TBD</td>
|
|
51
|
+
</tr>
|
|
52
|
+
</table>
|
|
53
|
+
</main>
|
|
54
|
+
</body>
|
|
55
|
+
</html>
|
|
56
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# ADR-0000: Decision Title
|
|
2
|
+
|
|
3
|
+
Status: Proposed
|
|
4
|
+
Date: YYYY-MM-DD
|
|
5
|
+
|
|
6
|
+
## Context
|
|
7
|
+
|
|
8
|
+
Describe the problem, constraints, forces, and options that make this
|
|
9
|
+
decision necessary.
|
|
10
|
+
|
|
11
|
+
## Decision
|
|
12
|
+
|
|
13
|
+
State the decision clearly.
|
|
14
|
+
|
|
15
|
+
## Consequences
|
|
16
|
+
|
|
17
|
+
Positive:
|
|
18
|
+
|
|
19
|
+
- Consequence 1
|
|
20
|
+
|
|
21
|
+
Negative or tradeoffs:
|
|
22
|
+
|
|
23
|
+
- Tradeoff 1
|
|
24
|
+
|
|
25
|
+
## Alternatives Considered
|
|
26
|
+
|
|
27
|
+
| Alternative | Why not |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
| TBD | TBD |
|
|
30
|
+
|
|
31
|
+
## Links
|
|
32
|
+
|
|
33
|
+
- Related specs, PRs, tickets, discussions, or code paths.
|
|
34
|
+
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Delivery
|
|
2
|
+
|
|
3
|
+
Use this file for CI/CD, build, release, and environment-promotion behavior.
|
|
4
|
+
Name the concern, not the tool. Pipeline definitions, workflow files,
|
|
5
|
+
deployment scripts, release toggles, and gates can all appear here when
|
|
6
|
+
relevant.
|
|
7
|
+
|
|
8
|
+
Start from `context/project-profile.md` for repo-wide delivery defaults.
|
|
9
|
+
Capture only initiative-specific pipeline, build, deployment, artifact, or
|
|
10
|
+
release changes here.
|
|
11
|
+
|
|
12
|
+
## Pipeline Impact
|
|
13
|
+
|
|
14
|
+
Describe pipeline, workflow, build, packaging, or artifact changes.
|
|
15
|
+
|
|
16
|
+
## Build And Release Gates
|
|
17
|
+
|
|
18
|
+
List checks that must pass before merge, deployment, promotion, or release.
|
|
19
|
+
|
|
20
|
+
| Gate | Applies to | Notes |
|
|
21
|
+
| --- | --- | --- |
|
|
22
|
+
| TBD | TBD | TBD |
|
|
23
|
+
|
|
24
|
+
## Deployment Flow
|
|
25
|
+
|
|
26
|
+
Describe deployment order, environment promotion, release windows, approvals,
|
|
27
|
+
and any sequencing constraints.
|
|
28
|
+
|
|
29
|
+
## Feature Flags And Toggles
|
|
30
|
+
|
|
31
|
+
List release flags, kill switches, configuration toggles, or staged rollout
|
|
32
|
+
controls.
|
|
33
|
+
|
|
34
|
+
## Delivery Automation
|
|
35
|
+
|
|
36
|
+
Capture scripts, commands, CLIs, jobs, or approved automation integrations
|
|
37
|
+
that agents or engineers can use to act on delivery.
|
|
38
|
+
|
|
39
|
+
> Reminder: reference secrets by name. Never embed tokens, credentials, or
|
|
40
|
+
> connection strings in commands or scripts captured here.
|
|
41
|
+
|
|
42
|
+
## Rollout Notes
|
|
43
|
+
|
|
44
|
+
Describe staged rollout, canary behavior, compatibility windows, or release
|
|
45
|
+
coordination.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Infrastructure
|
|
2
|
+
|
|
3
|
+
Use this file for environment shape and infrastructure dependencies. Name the
|
|
4
|
+
concern, not the tool. Infrastructure modules, resource templates, manifests,
|
|
5
|
+
or manual environment steps can all appear here when relevant.
|
|
6
|
+
|
|
7
|
+
Start from `context/project-profile.md` for repo-wide infrastructure and
|
|
8
|
+
configuration defaults. Capture only initiative-specific environment, IaC,
|
|
9
|
+
resource, secret, or migration changes here.
|
|
10
|
+
|
|
11
|
+
## Environment Shape
|
|
12
|
+
|
|
13
|
+
Describe new or changed resources, services, networks, identity boundaries,
|
|
14
|
+
storage, compute, queues, topics, or runtime hosts.
|
|
15
|
+
|
|
16
|
+
## Infrastructure As Code
|
|
17
|
+
|
|
18
|
+
List IaC modules, manifests, templates, parameters, or state changes.
|
|
19
|
+
|
|
20
|
+
| Resource or module | Change | Location | Status |
|
|
21
|
+
| --- | --- | --- | --- |
|
|
22
|
+
| TBD | TBD | TBD | Todo |
|
|
23
|
+
|
|
24
|
+
## Configuration And Secrets
|
|
25
|
+
|
|
26
|
+
List environment variables, app settings, feature flags, secrets, certificates,
|
|
27
|
+
secret manager references, or secret-rotation needs.
|
|
28
|
+
|
|
29
|
+
> Reminder: never paste secret values here. Record secret names, env var keys,
|
|
30
|
+
> and vault or secret-manager paths only -- never actual credentials, tokens,
|
|
31
|
+
> certificates, or connection strings. Treat this file as if it were public.
|
|
32
|
+
|
|
33
|
+
## Environment Dependencies
|
|
34
|
+
|
|
35
|
+
Capture dependencies between environments, regions, tenants, subscriptions,
|
|
36
|
+
clusters, accounts, or shared services.
|
|
37
|
+
|
|
38
|
+
## Compatibility And Migration
|
|
39
|
+
|
|
40
|
+
Describe infrastructure compatibility windows, provisioning order, migration
|
|
41
|
+
constraints, or cleanup work.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Interface
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Describe how humans, clients, APIs, configuration, reports, or tools
|
|
6
|
+
interact with this initiative.
|
|
7
|
+
|
|
8
|
+
## Surfaces
|
|
9
|
+
|
|
10
|
+
- UI:
|
|
11
|
+
- API:
|
|
12
|
+
- CLI or scripts:
|
|
13
|
+
- Configuration:
|
|
14
|
+
- Reports or exports:
|
|
15
|
+
|
|
16
|
+
Remove surfaces that do not apply.
|
|
17
|
+
|
|
18
|
+
## Workflows
|
|
19
|
+
|
|
20
|
+
Describe the user, operator, support, or integration workflows.
|
|
21
|
+
|
|
22
|
+
## Inputs And Outputs
|
|
23
|
+
|
|
24
|
+
| Surface | Inputs | Outputs |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| TBD | TBD | TBD |
|
|
27
|
+
|
|
28
|
+
## States And Feedback
|
|
29
|
+
|
|
30
|
+
Capture loading, empty, success, validation, warning, and error states when
|
|
31
|
+
they apply.
|
|
32
|
+
|
|
33
|
+
## Permissions
|
|
34
|
+
|
|
35
|
+
Describe who can see, change, trigger, approve, or audit the behavior.
|
|
36
|
+
|
|
37
|
+
## Terminology
|
|
38
|
+
|
|
39
|
+
Record terms that must stay consistent across UI, API, docs, logs, and
|
|
40
|
+
support language.
|
|
41
|
+
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Operations
|
|
2
|
+
|
|
3
|
+
Use this file only when the initiative has actionable runtime, support,
|
|
4
|
+
observability, rollback, or repair implications.
|
|
5
|
+
|
|
6
|
+
If there is nothing concrete for an agent or engineer to act on, omit this
|
|
7
|
+
file after copying the template or mark it as not applicable. Delivery belongs
|
|
8
|
+
in `delivery.md`; environment shape and IaC belong in `infrastructure.md`.
|
|
9
|
+
|
|
10
|
+
Start from `context/project-profile.md` for repo-wide observability, support,
|
|
11
|
+
rollback, and repair entry points. Capture only initiative-specific actionable
|
|
12
|
+
runtime or support changes here.
|
|
13
|
+
|
|
14
|
+
## Runtime Behavior
|
|
15
|
+
|
|
16
|
+
Describe how the live system behaves after the initiative ships, especially
|
|
17
|
+
jobs, schedules, queues, topics, subscriptions, retries, degraded modes, or
|
|
18
|
+
runtime compatibility constraints.
|
|
19
|
+
|
|
20
|
+
## Observability And Support Signals
|
|
21
|
+
|
|
22
|
+
Capture logs, metrics, traces, dashboards, alerts, health checks, support
|
|
23
|
+
signals, and customer-visible symptoms.
|
|
24
|
+
|
|
25
|
+
## Failure Modes
|
|
26
|
+
|
|
27
|
+
Describe expected failures, retries, poison-message behavior, timeouts,
|
|
28
|
+
partial outages, degraded modes, and support signals.
|
|
29
|
+
|
|
30
|
+
## Rollback And Recovery
|
|
31
|
+
|
|
32
|
+
Describe how to recover from bad runtime behavior. Include whether rollback is
|
|
33
|
+
safe, whether roll-forward is required, and what state must be repaired.
|
|
34
|
+
|
|
35
|
+
## Data Operations And Repair
|
|
36
|
+
|
|
37
|
+
Capture migrations, backfills, cleanups, retention, repair scripts, manual
|
|
38
|
+
support procedures, and validation queries.
|
|
39
|
+
|
|
40
|
+
> Reminder: redact secrets, connection strings, and personal data from any
|
|
41
|
+
> logs, queries, or procedures recorded here.
|
|
42
|
+
|
|
43
|
+
## Actionable Tooling
|
|
44
|
+
|
|
45
|
+
List CLIs, scripts, dashboards-as-code, alerts-as-code, or other approved
|
|
46
|
+
automation integrations that agents or engineers can use. If none exists, say
|
|
47
|
+
so explicitly.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Plan
|
|
2
|
+
|
|
3
|
+
Working alignment space — may be messy. Promote settled truth via `dive-into-plan`, not by expanding this file alone.
|
|
4
|
+
|
|
5
|
+
Use `plan-with-context` for the full change-surface checklist (code, tests, e2e, IaC, CI/CD, config, ops, security, reference impact).
|
|
6
|
+
|
|
7
|
+
## Current Alignment
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## Open Questions
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## Options Considered
|
|
16
|
+
|
|
17
|
+
| Option | Pros | Cons | Status |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| | | | |
|
|
20
|
+
|
|
21
|
+
## Notes To Promote
|
|
22
|
+
|
|
23
|
+
- [ ] Items to move into per-concern docs or `decisions/` during `dive-into-plan`
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Release Doc Notes
|
|
2
|
+
|
|
3
|
+
Use this file to capture reference impact while development is
|
|
4
|
+
in progress. At release time, these notes help refresh `reference/`
|
|
5
|
+
against the final shipped behavior.
|
|
6
|
+
|
|
7
|
+
Do not edit `reference/` from normal development work unless a human
|
|
8
|
+
explicitly asks for a reference refresh or a specific reference fix.
|
|
9
|
+
|
|
10
|
+
## Product Behavior Changes
|
|
11
|
+
|
|
12
|
+
- None yet.
|
|
13
|
+
|
|
14
|
+
## Candidate Reference Areas
|
|
15
|
+
|
|
16
|
+
- `reference/<Area>/README.md`
|
|
17
|
+
- `reference/<Area>/features/<feature>.md`
|
|
18
|
+
|
|
19
|
+
## QA Or Support Notes
|
|
20
|
+
|
|
21
|
+
- None yet.
|
|
22
|
+
|
|
23
|
+
## Exclusions
|
|
24
|
+
|
|
25
|
+
Record details that were considered but should not be documented because
|
|
26
|
+
they are internal implementation details, temporary scaffolding, or did not
|
|
27
|
+
ship.
|
|
28
|
+
|
|
29
|
+
## Release-Time Checklist
|
|
30
|
+
|
|
31
|
+
- [ ] Compare this initiative against the final shipped code.
|
|
32
|
+
- [ ] Update the relevant reference only after release-doc work
|
|
33
|
+
is explicitly requested.
|
|
34
|
+
- [ ] Add the release row if the reference workflow requires it.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Spec
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Describe what the system should do and why this behavior matters.
|
|
6
|
+
|
|
7
|
+
## Goals
|
|
8
|
+
|
|
9
|
+
- Goal 1
|
|
10
|
+
- Goal 2
|
|
11
|
+
|
|
12
|
+
## Non-Goals
|
|
13
|
+
|
|
14
|
+
- Non-goal 1
|
|
15
|
+
|
|
16
|
+
## Behavior
|
|
17
|
+
|
|
18
|
+
Describe the expected behavior in product or domain language. Include:
|
|
19
|
+
|
|
20
|
+
- Normal flow
|
|
21
|
+
- Permission rules
|
|
22
|
+
- Data rules
|
|
23
|
+
- Validation rules
|
|
24
|
+
- Error behavior
|
|
25
|
+
- Edge cases
|
|
26
|
+
|
|
27
|
+
## Acceptance Criteria
|
|
28
|
+
|
|
29
|
+
- [ ] Criterion 1
|
|
30
|
+
- [ ] Criterion 2
|
|
31
|
+
|
|
32
|
+
## Dependencies
|
|
33
|
+
|
|
34
|
+
- Related initiatives, systems, teams, services, or decisions.
|
|
35
|
+
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Testing
|
|
2
|
+
|
|
3
|
+
Use this file for the initiative's verification strategy. Name the concern,
|
|
4
|
+
not the tool. Specific test runners, unit test frameworks, contract tests, or
|
|
5
|
+
manual scripts can all appear here when they are relevant.
|
|
6
|
+
|
|
7
|
+
Start from `context/project-profile.md` for repo-wide default commands and
|
|
8
|
+
test tooling. Capture only initiative-specific additions, exceptions, data
|
|
9
|
+
needs, or release gates here.
|
|
10
|
+
|
|
11
|
+
## Test Strategy
|
|
12
|
+
|
|
13
|
+
Describe what must be proven before this initiative can ship.
|
|
14
|
+
|
|
15
|
+
## Automated Coverage
|
|
16
|
+
|
|
17
|
+
List unit, integration, contract, e2e, smoke, regression, or performance tests
|
|
18
|
+
that should be added or updated.
|
|
19
|
+
|
|
20
|
+
| Area | Coverage | Tool or location | Status |
|
|
21
|
+
| --- | --- | --- | --- |
|
|
22
|
+
| TBD | TBD | TBD | Todo |
|
|
23
|
+
|
|
24
|
+
## Manual Verification
|
|
25
|
+
|
|
26
|
+
List any human verification that remains necessary.
|
|
27
|
+
|
|
28
|
+
- None identified yet.
|
|
29
|
+
|
|
30
|
+
## Test Data And Environments
|
|
31
|
+
|
|
32
|
+
Capture required accounts, seeded data, fixtures, environment assumptions, or
|
|
33
|
+
data cleanup needs.
|
|
34
|
+
|
|
35
|
+
## Release Gates
|
|
36
|
+
|
|
37
|
+
List the checks that must pass before release.
|
|
38
|
+
|
|
39
|
+
- Existing CI test suite passes.
|
|
40
|
+
|
|
41
|
+
## Known Gaps
|
|
42
|
+
|
|
43
|
+
List accepted test gaps, why they are acceptable, and what would close them.
|
|
44
|
+
|
|
45
|
+
- None identified yet.
|
|
File without changes
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Project Profile
|
|
2
|
+
|
|
3
|
+
Project: PROJECT_NAME
|
|
4
|
+
Last reviewed: Not recorded
|
|
5
|
+
|
|
6
|
+
Repo-wide operating facts for agents. Initiative-specific detail lives under `context/initiatives/`. Record source-backed facts only; use `Unknown` when not yet reviewed.
|
|
7
|
+
|
|
8
|
+
## Repository Shape
|
|
9
|
+
|
|
10
|
+
| Concern | Location | Notes |
|
|
11
|
+
| --- | --- | --- |
|
|
12
|
+
| Application or package code | Unknown | |
|
|
13
|
+
| Tests | Unknown | |
|
|
14
|
+
| CI/CD and delivery | Unknown | |
|
|
15
|
+
| Infrastructure and config | Unknown | |
|
|
16
|
+
| Generated artifacts | Unknown | |
|
|
17
|
+
| Reference material | `reference/` | If reference-docs is installed |
|
|
18
|
+
| Decision log | `decisions/` | Append-only |
|
|
19
|
+
| Working context | `context/` | Disposable initiatives |
|
|
20
|
+
|
|
21
|
+
## Stack And Runtime
|
|
22
|
+
|
|
23
|
+
| Layer | Technology | Source | Notes |
|
|
24
|
+
| --- | --- | --- | --- |
|
|
25
|
+
| Runtime or language | Unknown | | |
|
|
26
|
+
| Package manager | Unknown | | |
|
|
27
|
+
| Frameworks | Unknown | | |
|
|
28
|
+
| Data stores or services | Unknown | | |
|
|
29
|
+
| Hosting or runtime platform | Unknown | | |
|
|
30
|
+
|
|
31
|
+
## Commands
|
|
32
|
+
|
|
33
|
+
| Concern | Command | Source | Notes |
|
|
34
|
+
| --- | --- | --- | --- |
|
|
35
|
+
| Install dependencies | Unknown | | |
|
|
36
|
+
| Run locally | Unknown | | |
|
|
37
|
+
| Build | Unknown | | |
|
|
38
|
+
| Lint, format, or typecheck | Unknown | | |
|
|
39
|
+
| Unit or integration tests | Unknown | | |
|
|
40
|
+
| E2E or smoke tests | Unknown | | |
|
|
41
|
+
| Package or release | Unknown | | |
|
|
42
|
+
|
|
43
|
+
## Verification Profile
|
|
44
|
+
|
|
45
|
+
- Default test expectation: Unknown.
|
|
46
|
+
- Required release gates: Unknown.
|
|
47
|
+
- Manual checks: Unknown.
|
|
48
|
+
- Test data and environment dependencies: Unknown.
|
|
49
|
+
|
|
50
|
+
## Delivery Profile
|
|
51
|
+
|
|
52
|
+
- CI/CD workflow files: Unknown.
|
|
53
|
+
- Deployment entry points: Unknown.
|
|
54
|
+
- Environments and promotion flow: Unknown.
|
|
55
|
+
- Artifacts and publishing flow: Unknown.
|
|
56
|
+
|
|
57
|
+
## Infrastructure And Configuration
|
|
58
|
+
|
|
59
|
+
- IaC or config roots: Unknown.
|
|
60
|
+
- Managed services: Unknown.
|
|
61
|
+
- Secrets references (names only): Unknown.
|
|
62
|
+
- Environment dependencies: Unknown.
|
|
63
|
+
|
|
64
|
+
## Operations Profile
|
|
65
|
+
|
|
66
|
+
- Logs, metrics, alerts: Unknown.
|
|
67
|
+
- Rollback and repair tooling: Unknown.
|