code-anchored-context 0.2.3 → 0.2.4
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/.agents/skills/code-anchored-context/SKILL.md +31 -1
- package/AGENTS.md +3 -0
- package/README.md +8 -4
- package/bin/code-anchored-context.js +7 -0
- package/context/AGENTS.md +6 -0
- package/context/README.md +31 -0
- package/context/_templates/initiative/README.md +2 -0
- package/context/_templates/initiative/delivery.md +4 -0
- package/context/_templates/initiative/infrastructure.md +4 -0
- package/context/_templates/initiative/operations.md +4 -0
- package/context/_templates/initiative/testing.md +4 -0
- package/context/_templates/planned-initiative/README.md +2 -0
- package/context/_templates/planned-initiative/delivery.md +4 -0
- package/context/_templates/planned-initiative/infrastructure.md +4 -0
- package/context/_templates/planned-initiative/operations.md +4 -0
- package/context/_templates/planned-initiative/testing.md +4 -0
- package/context/current.md +4 -0
- package/context/project-profile.md +130 -0
- package/context/terminology.md +4 -0
- package/package.json +2 -1
- package/reference/_authoring/workflow.md +4 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: code-anchored-context
|
|
3
|
-
description: Use central repository context for planning and implementation. Use when starting, changing, reviewing, or documenting behavior-changing work; when checking or updating context/current.md, context/releases/*/initiatives/*, context/programs/*, context/programs/*/planned-initiatives/*, context/backlog/items/*, specs, plans, interface notes, architecture notes, testing notes, delivery notes, infrastructure notes, actionable operations notes, ADRs, backlog, release-doc-notes.md; when promoting planned initiatives during release transitions; or when deciding whether reference/ should be left untouched.
|
|
3
|
+
description: Use central repository context for planning and implementation. Use when starting, changing, reviewing, or documenting behavior-changing work; when checking or updating context/current.md, context/project-profile.md, context/releases/*/initiatives/*, context/programs/*, context/programs/*/planned-initiatives/*, context/backlog/items/*, specs, plans, interface notes, architecture notes, testing notes, delivery notes, infrastructure notes, actionable operations notes, ADRs, backlog, release-doc-notes.md; when promoting planned initiatives during release transitions; or when deciding whether reference/ should be left untouched.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Code-Anchored Context
|
|
@@ -16,6 +16,9 @@ Working context should also cover delivery concerns such as testing,
|
|
|
16
16
|
delivery pipelines, and infrastructure when they affect how the work is
|
|
17
17
|
verified, shipped, deployed, or hosted.
|
|
18
18
|
|
|
19
|
+
Repo-specific stack and toolchain facts belong in
|
|
20
|
+
`context/project-profile.md`, not in this reusable skill.
|
|
21
|
+
|
|
19
22
|
## Workflow
|
|
20
23
|
|
|
21
24
|
### 1) Read The Local Rules
|
|
@@ -32,6 +35,24 @@ Use `context/terminology.md` as the canonical vocabulary for programs,
|
|
|
32
35
|
planned initiatives, release initiatives, backlog items, statuses, and
|
|
33
36
|
promotion.
|
|
34
37
|
|
|
38
|
+
Open `context/project-profile.md` when it exists. It is the repo-wide
|
|
39
|
+
operating profile for stack, commands, source roots, verification layers,
|
|
40
|
+
CI/CD, delivery automation, infrastructure, observability, and generated
|
|
41
|
+
artifacts. Use it before inventing default commands or tooling assumptions.
|
|
42
|
+
|
|
43
|
+
If a human explicitly asks for a project profile, tech-stack baseline, or
|
|
44
|
+
repository operating baseline, create or refresh `context/project-profile.md`
|
|
45
|
+
by inspecting source-backed local facts: manifests, lockfiles, runtime version
|
|
46
|
+
files, build config, test config, CI/CD workflows, deployment scripts,
|
|
47
|
+
infrastructure config, observability config, generated-artifact owners, and
|
|
48
|
+
existing docs. Do not guess. Mark unknowns clearly and cite source paths where
|
|
49
|
+
useful.
|
|
50
|
+
|
|
51
|
+
If the human asks for a "baseline" without saying whether they mean an
|
|
52
|
+
operating profile or accepted behavior reference, distinguish
|
|
53
|
+
`context/project-profile.md` from baseline reference under `reference/` before
|
|
54
|
+
editing.
|
|
55
|
+
|
|
35
56
|
If the workspace starts inside a subfolder, navigate upward to the repository
|
|
36
57
|
root when the environment allows it. If `context/` is not available in
|
|
37
58
|
the workspace, mention that limitation in the task summary.
|
|
@@ -50,6 +71,9 @@ Search for:
|
|
|
50
71
|
- the feature or bug name
|
|
51
72
|
- affected concern names, such as product code, APIs, contracts, tests,
|
|
52
73
|
delivery, CI/CD, infrastructure, config, generated artifacts, or automation
|
|
74
|
+
- repo-wide toolchain facts from `context/project-profile.md`, such as test
|
|
75
|
+
commands, e2e tooling, observability tooling, deploy CLIs, source roots,
|
|
76
|
+
generated artifacts, or CI/CD files
|
|
53
77
|
- related domain terms, APIs, jobs, entities, routes, config names, or tickets
|
|
54
78
|
|
|
55
79
|
Use an existing initiative when the work belongs to it, even if the code
|
|
@@ -165,6 +189,9 @@ Use these files as the standard map:
|
|
|
165
189
|
- `backlog.md`: work slices and implementation progress
|
|
166
190
|
- `decisions/ADR-*.md`: meaningful choices and their consequences
|
|
167
191
|
- `release-doc-notes.md`: reference impact to review at release
|
|
192
|
+
- `context/project-profile.md`: repo-wide stack, command, testing, delivery,
|
|
193
|
+
infrastructure, observability, and generated-artifact facts; update it only
|
|
194
|
+
for stable source-backed discoveries or an explicit baseline request
|
|
168
195
|
|
|
169
196
|
Not every initiative needs every file. Mark a file as not applicable or omit
|
|
170
197
|
it after copying the template when it genuinely does not apply.
|
|
@@ -197,6 +224,9 @@ folder. Do not create area-local copies of initiative documents.
|
|
|
197
224
|
Before finishing behavior-changing work:
|
|
198
225
|
|
|
199
226
|
- The matching initiative was read or a reason was given for why none exists.
|
|
227
|
+
- `context/project-profile.md` was read when present and relevant to
|
|
228
|
+
verification, delivery, infrastructure, operations, or generated artifacts;
|
|
229
|
+
if a human requested a baseline, it was populated from source-backed facts.
|
|
200
230
|
- Matching programs or context backlog items were checked when the work
|
|
201
231
|
appears phased, deferred, or multi-release.
|
|
202
232
|
- Planned initiatives were checked or created when future program scope is
|
package/AGENTS.md
CHANGED
|
@@ -8,6 +8,9 @@ subfolders layer on top of it. Read those too when working in a given area.
|
|
|
8
8
|
In-progress specs, plans, ADRs, backlog, implementation context, and
|
|
9
9
|
release-documentation notes live under [`context/`](context/).
|
|
10
10
|
Start with [`context/current.md`](context/current.md).
|
|
11
|
+
Use [`context/project-profile.md`](context/project-profile.md) for
|
|
12
|
+
repo-wide stack, command, testing, delivery, infrastructure, observability,
|
|
13
|
+
and generated-artifact facts when it has been populated.
|
|
11
14
|
|
|
12
15
|
For behavior-changing work, use the repo-wide skill at
|
|
13
16
|
[`.agents/skills/code-anchored-context/SKILL.md`](.agents/skills/code-anchored-context/SKILL.md).
|
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ It separates two kinds of truth:
|
|
|
8
8
|
|
|
9
9
|
| Folder | Meaning | Updated when |
|
|
10
10
|
| --- | --- | --- |
|
|
11
|
-
| `context/` | What the team is planning, building, deciding, validating, shipping, hosting, deferring, and learning. | During normal development. |
|
|
11
|
+
| `context/` | What the team is planning, building, deciding, validating, shipping, hosting, deferring, and learning, plus optional repo-wide operating facts in `project-profile.md`. | During normal development. |
|
|
12
12
|
| `reference/` | What the system does as of a known release or explicit baseline. | Only during explicit reference refresh work. |
|
|
13
13
|
|
|
14
14
|
The goal is to give humans and AI agents enough structured context to change a
|
|
@@ -21,7 +21,8 @@ notes.
|
|
|
21
21
|
- `.agents/skills/code-anchored-context/SKILL.md` for the recurring
|
|
22
22
|
working-context workflow.
|
|
23
23
|
- `context/` with terminology, release context, backlog/program structure,
|
|
24
|
-
initiative templates, and
|
|
24
|
+
a repo-wide project profile starter, initiative templates, and
|
|
25
|
+
release-documentation notes.
|
|
25
26
|
- `reference/` with a generic release-anchored reference workflow,
|
|
26
27
|
authoring guide structure, and area/page templates.
|
|
27
28
|
|
|
@@ -55,9 +56,12 @@ Manual adoption still works:
|
|
|
55
56
|
3. Set the first active release in `context/current.md`.
|
|
56
57
|
4. Add or revise area-specific `AGENTS.md` files so they point back to
|
|
57
58
|
`context/` and `reference/_authoring/`.
|
|
58
|
-
5.
|
|
59
|
+
5. If you want a repo operating profile, ask an agent to populate
|
|
60
|
+
`context/project-profile.md` from source files, manifests, CI/CD,
|
|
61
|
+
infrastructure, test config, and observability tooling.
|
|
62
|
+
6. Create `reference/_authoring/areas/<area>.md` for each referenced
|
|
59
63
|
product or code area.
|
|
60
|
-
|
|
64
|
+
7. Keep product or domain-specific reference content out of this template repo.
|
|
61
65
|
|
|
62
66
|
## Publishing The Package
|
|
63
67
|
|
|
@@ -304,6 +304,9 @@ class Installer {
|
|
|
304
304
|
In-progress specs, plans, ADRs, backlog, implementation context, and
|
|
305
305
|
release-documentation notes live under [\`context/\`](context/).
|
|
306
306
|
Start with [\`context/current.md\`](context/current.md).
|
|
307
|
+
Use [\`context/project-profile.md\`](context/project-profile.md) for
|
|
308
|
+
repo-wide stack, command, testing, delivery, infrastructure, observability,
|
|
309
|
+
and generated-artifact facts when it has been populated.
|
|
307
310
|
|
|
308
311
|
For behavior-changing work, use the repo-wide skill at
|
|
309
312
|
[\`.agents/skills/${skillName}/SKILL.md\`](.agents/skills/${skillName}/SKILL.md).
|
|
@@ -486,6 +489,10 @@ Start here:
|
|
|
486
489
|
- \`releases/${this.release}/backlog.md\`
|
|
487
490
|
- \`releases/${this.release}/initiatives/\`
|
|
488
491
|
|
|
492
|
+
Project-wide operating profile:
|
|
493
|
+
|
|
494
|
+
- \`project-profile.md\`
|
|
495
|
+
|
|
489
496
|
Durable or deferred context:
|
|
490
497
|
|
|
491
498
|
- \`programs/\`
|
package/context/AGENTS.md
CHANGED
|
@@ -7,6 +7,9 @@ Scope: everything under `/context`.
|
|
|
7
7
|
This folder is the canonical home for in-progress working context: specs,
|
|
8
8
|
interface notes, architecture notes, actionable operations notes, ADRs,
|
|
9
9
|
backlogs, implementation plans, and release-documentation notes.
|
|
10
|
+
`project-profile.md` is the canonical home for repo-wide operating facts such
|
|
11
|
+
as stack, commands, test layers, CI/CD, infrastructure, observability, and
|
|
12
|
+
generated artifacts when a baseline has been populated.
|
|
10
13
|
|
|
11
14
|
Testing, delivery, and infrastructure notes belong here when they affect how
|
|
12
15
|
work is verified, shipped, deployed, or hosted. Operational notes belong here
|
|
@@ -20,6 +23,9 @@ repair context.
|
|
|
20
23
|
|
|
21
24
|
- Use `context/terminology.md` as the canonical vocabulary for programs,
|
|
22
25
|
planned initiatives, release initiatives, backlog items, and promotion.
|
|
26
|
+
- Use `context/project-profile.md` for stable repo-wide operating facts.
|
|
27
|
+
Populate it only from source-backed discovery or an explicit human request
|
|
28
|
+
for a repository baseline.
|
|
23
29
|
- Keep initiative knowledge centralized here. Area `AGENTS.md` files may point
|
|
24
30
|
here, but they should not duplicate initiative content.
|
|
25
31
|
- Do not move in-progress plans into `reference/`.
|
package/context/README.md
CHANGED
|
@@ -8,10 +8,16 @@ notes, infrastructure notes, actionable operations notes, ADRs, backlog items,
|
|
|
8
8
|
implementation plans, and release-documentation notes. Do not use
|
|
9
9
|
`reference/` for in-progress development planning.
|
|
10
10
|
|
|
11
|
+
Use `project-profile.md` for repo-wide operating facts such as stack,
|
|
12
|
+
commands, verification layers, CI/CD, infrastructure, observability, and
|
|
13
|
+
generated artifacts.
|
|
14
|
+
|
|
11
15
|
## Start Here
|
|
12
16
|
|
|
13
17
|
- `terminology.md` defines the shared vocabulary.
|
|
14
18
|
- `current.md` points to the active release context.
|
|
19
|
+
- `project-profile.md` captures repo-wide stack, command, testing, delivery,
|
|
20
|
+
infrastructure, operations, and generated-artifact facts when populated.
|
|
15
21
|
- `programs/` contains durable multi-release working context.
|
|
16
22
|
- `backlog/` contains deferred isolated work cut from initiatives.
|
|
17
23
|
- `releases/` contains release-scoped working context.
|
|
@@ -63,6 +69,9 @@ The delivery-surface rule is:
|
|
|
63
69
|
|
|
64
70
|
Use `testing.md`, `delivery.md`, and `infrastructure.md` for concern-based
|
|
65
71
|
context. Mention specific tools inside those files only when the tools matter.
|
|
72
|
+
Use `project-profile.md` for repo-wide defaults such as package manager,
|
|
73
|
+
common commands, test tools, delivery automation, infrastructure tooling, and
|
|
74
|
+
observability entry points.
|
|
66
75
|
|
|
67
76
|
Mermaid diagrams are encouraged for flows, dependencies, and lifecycle maps
|
|
68
77
|
because they stay readable as Markdown for agents while rendering as visible
|
|
@@ -80,6 +89,7 @@ not copy specs, plans, or ADRs into area-local documents.
|
|
|
80
89
|
```text
|
|
81
90
|
context/
|
|
82
91
|
current.md
|
|
92
|
+
project-profile.md
|
|
83
93
|
programs/
|
|
84
94
|
<program-slug>/
|
|
85
95
|
README.md
|
|
@@ -120,6 +130,27 @@ context/
|
|
|
120
130
|
brief.html
|
|
121
131
|
```
|
|
122
132
|
|
|
133
|
+
## Project Profile
|
|
134
|
+
|
|
135
|
+
`project-profile.md` is the optional repo-wide operating profile. It answers
|
|
136
|
+
questions future agents routinely need before changing behavior:
|
|
137
|
+
|
|
138
|
+
- where code, tests, config, infrastructure, generated artifacts, and
|
|
139
|
+
reference material live
|
|
140
|
+
- which runtime, package manager, frameworks, services, and hosting platform
|
|
141
|
+
the project uses
|
|
142
|
+
- which commands verify, build, package, run, deploy, or release the project
|
|
143
|
+
- which CI/CD, IaC, observability, support, rollback, and repair tools matter
|
|
144
|
+
|
|
145
|
+
Populate it when a human asks for a project profile, tech-stack baseline, or
|
|
146
|
+
repository operating baseline, or when a concrete repo-wide fact is discovered
|
|
147
|
+
during work. Do not guess. Mark unknowns explicitly and cite source paths
|
|
148
|
+
where possible.
|
|
149
|
+
|
|
150
|
+
Initiatives can rely on the project profile for stable defaults. Put only the
|
|
151
|
+
initiative-specific changes, exceptions, and release gates in the initiative's
|
|
152
|
+
`testing.md`, `delivery.md`, `infrastructure.md`, or `operations.md`.
|
|
153
|
+
|
|
123
154
|
## Programs
|
|
124
155
|
|
|
125
156
|
Programs preserve durable context for work that spans releases or phases. Use a
|
|
@@ -17,6 +17,8 @@ produce.
|
|
|
17
17
|
- Tests or verification: `path/to/...`
|
|
18
18
|
- Delivery, CI/CD, build, or artifacts: `path/to/...`
|
|
19
19
|
- Infrastructure, IaC, or environment config: `path/to/...`
|
|
20
|
+
- Repo-wide operating profile: `context/project-profile.md` if a stable
|
|
21
|
+
project fact changes
|
|
20
22
|
- Reference or release notes: `path/to/...`
|
|
21
23
|
|
|
22
24
|
Remove entries that do not apply and add the real paths. Prefer naming the
|
|
@@ -5,6 +5,10 @@ Name the concern, not the tool. Pipeline definitions, workflow files,
|
|
|
5
5
|
deployment scripts, release toggles, and gates can all appear here when
|
|
6
6
|
relevant.
|
|
7
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
|
+
|
|
8
12
|
## Pipeline Impact
|
|
9
13
|
|
|
10
14
|
Describe pipeline, workflow, build, packaging, or artifact changes.
|
|
@@ -4,6 +4,10 @@ Use this file for environment shape and infrastructure dependencies. Name the
|
|
|
4
4
|
concern, not the tool. Infrastructure modules, resource templates, manifests,
|
|
5
5
|
or manual environment steps can all appear here when relevant.
|
|
6
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
|
+
|
|
7
11
|
## Environment Shape
|
|
8
12
|
|
|
9
13
|
Describe new or changed resources, services, networks, identity boundaries,
|
|
@@ -7,6 +7,10 @@ If there is nothing concrete for an agent or engineer to act on, omit this
|
|
|
7
7
|
file after copying the template or mark it as not applicable. Delivery belongs
|
|
8
8
|
in `delivery.md`; environment shape and IaC belong in `infrastructure.md`.
|
|
9
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
|
+
|
|
10
14
|
## Runtime Behavior
|
|
11
15
|
|
|
12
16
|
Describe how the live system behaves after the initiative ships, especially
|
|
@@ -4,6 +4,10 @@ Use this file for the initiative's verification strategy. Name the concern,
|
|
|
4
4
|
not the tool. Specific test runners, unit test frameworks, contract tests, or
|
|
5
5
|
manual scripts can all appear here when they are relevant.
|
|
6
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
|
+
|
|
7
11
|
## Test Strategy
|
|
8
12
|
|
|
9
13
|
Describe what must be proven before this initiative can ship.
|
|
@@ -19,6 +19,8 @@ and what outcome it should produce.
|
|
|
19
19
|
- Tests or verification: `path/to/...`
|
|
20
20
|
- Delivery, CI/CD, build, or artifacts: `path/to/...`
|
|
21
21
|
- Infrastructure, IaC, or environment config: `path/to/...`
|
|
22
|
+
- Repo-wide operating profile: `context/project-profile.md` if a stable
|
|
23
|
+
project fact is expected to change
|
|
22
24
|
- Reference or release notes: `path/to/...`
|
|
23
25
|
|
|
24
26
|
Remove entries that do not apply and add the real paths. Prefer naming the
|
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
Use this file for future CI/CD, build, release, and environment-promotion
|
|
4
4
|
behavior that is already clear enough to preserve.
|
|
5
5
|
|
|
6
|
+
Start from `context/project-profile.md` for repo-wide delivery defaults.
|
|
7
|
+
Capture only planned initiative-specific pipeline, build, deployment,
|
|
8
|
+
artifact, or release changes here.
|
|
9
|
+
|
|
6
10
|
## Pipeline Impact
|
|
7
11
|
|
|
8
12
|
Describe expected pipeline, workflow, build, packaging, or artifact changes.
|
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
Use this file for future environment shape and infrastructure dependencies
|
|
4
4
|
that are already clear enough to preserve.
|
|
5
5
|
|
|
6
|
+
Start from `context/project-profile.md` for repo-wide infrastructure and
|
|
7
|
+
configuration defaults. Capture only planned initiative-specific environment,
|
|
8
|
+
IaC, resource, secret, or migration changes here.
|
|
9
|
+
|
|
6
10
|
## Environment Shape
|
|
7
11
|
|
|
8
12
|
Describe expected resources, services, networks, identity boundaries, storage,
|
|
@@ -8,6 +8,10 @@ If there is nothing concrete for an agent or engineer to act on, omit this
|
|
|
8
8
|
file after copying the template or mark it as not applicable. Delivery belongs
|
|
9
9
|
in `delivery.md`; environment shape and IaC belong in `infrastructure.md`.
|
|
10
10
|
|
|
11
|
+
Start from `context/project-profile.md` for repo-wide observability, support,
|
|
12
|
+
rollback, and repair entry points. Capture only planned initiative-specific
|
|
13
|
+
actionable runtime or support changes here.
|
|
14
|
+
|
|
11
15
|
## Runtime Behavior
|
|
12
16
|
|
|
13
17
|
Describe expected live-system behavior, especially jobs, schedules, queues,
|
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
Use this file for future verification strategy that is already clear enough to
|
|
4
4
|
preserve before the target release becomes current.
|
|
5
5
|
|
|
6
|
+
Start from `context/project-profile.md` for repo-wide default commands and
|
|
7
|
+
test tooling. Capture only planned initiative-specific additions, exceptions,
|
|
8
|
+
data needs, or release gates here.
|
|
9
|
+
|
|
6
10
|
## Test Strategy
|
|
7
11
|
|
|
8
12
|
Describe what the future release initiative will need to prove.
|
package/context/current.md
CHANGED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# Project Profile
|
|
2
|
+
|
|
3
|
+
Project: PROJECT_NAME
|
|
4
|
+
Baseline status: Not populated yet.
|
|
5
|
+
Last reviewed: Not recorded.
|
|
6
|
+
|
|
7
|
+
This file captures repo-wide operating facts that agents should know before
|
|
8
|
+
changing behavior. It is for stable project facts such as stack, source roots,
|
|
9
|
+
commands, verification layers, delivery flow, infrastructure, observability,
|
|
10
|
+
and generated artifacts.
|
|
11
|
+
|
|
12
|
+
Do not put initiative-specific planning here. Use release initiatives under
|
|
13
|
+
`context/releases/` for work-specific behavior, testing, delivery,
|
|
14
|
+
infrastructure, and operations context.
|
|
15
|
+
|
|
16
|
+
## When To Populate Or Refresh
|
|
17
|
+
|
|
18
|
+
Populate or refresh this file when a human explicitly asks for a project
|
|
19
|
+
profile, tech-stack baseline, or repository operating baseline, or when a
|
|
20
|
+
concrete repo-wide fact is discovered during work and would help future
|
|
21
|
+
agents.
|
|
22
|
+
|
|
23
|
+
Record facts that can be traced to source files. Do not guess. If something is
|
|
24
|
+
not known yet, mark it as `Unknown` and include the source paths that still
|
|
25
|
+
need review.
|
|
26
|
+
|
|
27
|
+
## Source Scan Checklist
|
|
28
|
+
|
|
29
|
+
Use this checklist during a baseline pass:
|
|
30
|
+
|
|
31
|
+
- package manifests, lockfiles, language/runtime version files, and build
|
|
32
|
+
config
|
|
33
|
+
- source roots, application boundaries, libraries, services, APIs, jobs, and
|
|
34
|
+
generated artifacts
|
|
35
|
+
- test configuration, e2e tooling, fixtures, seeded data, and test
|
|
36
|
+
environments
|
|
37
|
+
- CI/CD workflows, deployment scripts, release toggles, artifact publishing,
|
|
38
|
+
and environment promotion
|
|
39
|
+
- infrastructure as code, service configuration, secrets references, and
|
|
40
|
+
environment dependencies
|
|
41
|
+
- observability, logs, metrics, traces, alerts, dashboards, support tools,
|
|
42
|
+
rollback, and repair procedures
|
|
43
|
+
|
|
44
|
+
## Repository Shape
|
|
45
|
+
|
|
46
|
+
| Concern | Location | Notes |
|
|
47
|
+
| --- | --- | --- |
|
|
48
|
+
| Application or package code | Unknown | TBD |
|
|
49
|
+
| Tests | Unknown | TBD |
|
|
50
|
+
| CI/CD and delivery | Unknown | TBD |
|
|
51
|
+
| Infrastructure and config | Unknown | TBD |
|
|
52
|
+
| Generated artifacts | Unknown | TBD |
|
|
53
|
+
| Reference material | `reference/` | Release-anchored or baseline behavior. |
|
|
54
|
+
| Working context | `context/` | Plans, initiatives, programs, ADRs, backlog, and release notes. |
|
|
55
|
+
|
|
56
|
+
## Stack And Runtime
|
|
57
|
+
|
|
58
|
+
| Layer | Technology | Source | Notes |
|
|
59
|
+
| --- | --- | --- | --- |
|
|
60
|
+
| Runtime or language | Unknown | TBD | TBD |
|
|
61
|
+
| Package manager | Unknown | TBD | TBD |
|
|
62
|
+
| Frameworks | Unknown | TBD | TBD |
|
|
63
|
+
| Data stores or services | Unknown | TBD | TBD |
|
|
64
|
+
| Hosting or runtime platform | Unknown | TBD | TBD |
|
|
65
|
+
|
|
66
|
+
## Commands
|
|
67
|
+
|
|
68
|
+
| Concern | Command | Source | Notes |
|
|
69
|
+
| --- | --- | --- | --- |
|
|
70
|
+
| Install dependencies | Unknown | TBD | TBD |
|
|
71
|
+
| Run locally | Unknown | TBD | TBD |
|
|
72
|
+
| Build | Unknown | TBD | TBD |
|
|
73
|
+
| Lint, format, or typecheck | Unknown | TBD | TBD |
|
|
74
|
+
| Unit or integration tests | Unknown | TBD | TBD |
|
|
75
|
+
| E2E or smoke tests | Unknown | TBD | TBD |
|
|
76
|
+
| Package or release | Unknown | TBD | TBD |
|
|
77
|
+
|
|
78
|
+
## Verification Profile
|
|
79
|
+
|
|
80
|
+
- Default test expectation: Unknown.
|
|
81
|
+
- Required release gates: Unknown.
|
|
82
|
+
- Manual checks: Unknown.
|
|
83
|
+
- Test data and environment dependencies: Unknown.
|
|
84
|
+
- Known verification gaps: Unknown.
|
|
85
|
+
|
|
86
|
+
Use initiative `testing.md` files for work-specific additions, exceptions, and
|
|
87
|
+
release gates.
|
|
88
|
+
|
|
89
|
+
## Delivery Profile
|
|
90
|
+
|
|
91
|
+
- CI/CD workflow files: Unknown.
|
|
92
|
+
- Deployment entry points: Unknown.
|
|
93
|
+
- Environments and promotion flow: Unknown.
|
|
94
|
+
- Release approvals or gates: Unknown.
|
|
95
|
+
- Artifacts and publishing flow: Unknown.
|
|
96
|
+
- Delivery automation CLIs or scripts: Unknown.
|
|
97
|
+
|
|
98
|
+
Use initiative `delivery.md` files for work-specific pipeline, build,
|
|
99
|
+
deployment, or release changes.
|
|
100
|
+
|
|
101
|
+
## Infrastructure And Configuration
|
|
102
|
+
|
|
103
|
+
- IaC, manifests, or config roots: Unknown.
|
|
104
|
+
- Managed services and resources: Unknown.
|
|
105
|
+
- Secrets and configuration references: Unknown.
|
|
106
|
+
- Environment dependencies: Unknown.
|
|
107
|
+
- Compatibility or migration constraints: Unknown.
|
|
108
|
+
|
|
109
|
+
Use initiative `infrastructure.md` files for work-specific environment or IaC
|
|
110
|
+
changes.
|
|
111
|
+
|
|
112
|
+
## Operations Profile
|
|
113
|
+
|
|
114
|
+
- Logs: Unknown.
|
|
115
|
+
- Metrics, traces, or dashboards: Unknown.
|
|
116
|
+
- Alerts and health checks: Unknown.
|
|
117
|
+
- Support tooling: Unknown.
|
|
118
|
+
- Rollback, recovery, and repair tooling: Unknown.
|
|
119
|
+
|
|
120
|
+
Use initiative `operations.md` files only for actionable runtime, support,
|
|
121
|
+
observability, rollback, or repair concerns tied to a specific change.
|
|
122
|
+
|
|
123
|
+
## Agent Notes
|
|
124
|
+
|
|
125
|
+
- Keep this file factual and source-backed.
|
|
126
|
+
- Prefer commands already defined by the repo over ad hoc alternatives.
|
|
127
|
+
- Mention specific tools only when they affect how agents should verify,
|
|
128
|
+
ship, deploy, observe, or support the project.
|
|
129
|
+
- If a generated file or managed artifact should not be edited directly,
|
|
130
|
+
record that here with the owning source location.
|
package/context/terminology.md
CHANGED
|
@@ -11,6 +11,7 @@ backlog items, ADRs, agent summaries, and release-transition work.
|
|
|
11
11
|
| `context/` | Working context: plans, specs, ADRs, implementation notes, delivery-surface context, future scope, and release-documentation notes. |
|
|
12
12
|
| `reference/` | Accepted reference. It describes shipped or baseline behavior for a release/tag and is not edited during normal development work. |
|
|
13
13
|
| `context/current.md` | Pointer to the current active release context. Updating this is a release transition. |
|
|
14
|
+
| `context/project-profile.md` | Optional repo-wide operating profile for stack, commands, source roots, verification, delivery, infrastructure, observability, and generated artifacts. |
|
|
14
15
|
| `context/releases/<version>/` | Release-scoped working context for one version. |
|
|
15
16
|
| `context/programs/` | Durable multi-release working context. |
|
|
16
17
|
| `context/backlog/items/` | Deferred isolated work cut from initiatives but worth preserving. |
|
|
@@ -44,6 +45,8 @@ scope and should be preserved, but it does not need program-level context.
|
|
|
44
45
|
The structure follows delivery concerns, not technologies. Use concern names
|
|
45
46
|
such as `testing.md`, `delivery.md`, and `infrastructure.md`; name specific
|
|
46
47
|
tools inside those files only when the tools matter.
|
|
48
|
+
Use `project-profile.md` for repo-wide defaults and toolchain facts, then use
|
|
49
|
+
initiative files for work-specific changes and exceptions.
|
|
47
50
|
|
|
48
51
|
Mermaid is the preferred diagram syntax for working context because it is
|
|
49
52
|
both readable Markdown for agents and renderable visual context for humans.
|
|
@@ -51,6 +54,7 @@ both readable Markdown for agents and renderable visual context for humans.
|
|
|
51
54
|
| Term | Meaning |
|
|
52
55
|
| --- | --- |
|
|
53
56
|
| `README.md` | Entry point for a folder. It should explain status, scope, links, and where to start. |
|
|
57
|
+
| `project-profile.md` | Repo-wide operating profile. Populate it on human request or when source-backed facts are discovered during work. |
|
|
54
58
|
| `plan.md` | Working alignment space for humans and agents. It may be messy, but settled truth must move into stable files. |
|
|
55
59
|
| `spec.md` | Stable description of what the system should do. |
|
|
56
60
|
| `interface.md` | Stable description of how humans, clients, APIs, config, reports, or tools interact with the work. |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "code-anchored-context",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "Install repo-local agent context, release initiatives, and release-anchored reference scaffolding into an existing project.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
"context/_templates/",
|
|
16
16
|
"context/backlog/",
|
|
17
17
|
"context/current.md",
|
|
18
|
+
"context/project-profile.md",
|
|
18
19
|
"context/programs/",
|
|
19
20
|
"context/releases/v0_1_0/README.md",
|
|
20
21
|
"context/releases/v0_1_0/backlog.md",
|
|
@@ -55,6 +55,10 @@ When creating a baseline:
|
|
|
55
55
|
Baseline reference is a snapshot of the system as adopted; it is not a
|
|
56
56
|
promise that every undocumented behavior is unimportant.
|
|
57
57
|
|
|
58
|
+
This is different from `context/project-profile.md`, which captures the
|
|
59
|
+
repo-wide operating profile: stack, commands, verification, delivery,
|
|
60
|
+
infrastructure, observability, and generated-artifact facts.
|
|
61
|
+
|
|
58
62
|
### Release-Forward Reference
|
|
59
63
|
|
|
60
64
|
Use this mode when the team chooses not to create a full baseline. In this
|