Defame1297
38f1ba4e03
Claude Code's (and Copilot's) native plugin installer has zero awareness of .apm/ nesting -- it convention-scans only flat skills/, agents/, commands/, hooks.json at each plugin's root. Confirmed via strings on the installed claude binary and live installs of git@holocron/gitea@holocron/kyberforge@ holocron, all reporting Skills(0) Agents(0) Hooks(0) post ADR-0015's apm conversion. Root cause (apm_cli/core/plugin_manifest.py): apm's plugin.json compiler deliberately strips skills/agents/commands keys, assuming the host already auto-discovers those convention directories -- it has no model of .apm/ being host-visible at all. Separately, apm's own bundle exporter (apm_cli/bundle/plugin_exporter.py, behind `apm pack --format plugin`) implements the correct .apm/ -> flat mapping, but only ever targeted build/<name>-<version>/, a path nothing in marketplace.json's source: points at. scripts/sync-plugin-content.sh wraps that bundle exporter and copies its agents/, skills/, commands/, instructions/, extensions/, and merged hooks.json back into each plugin's own root as a second tracked compiled-output category -- same governance status as .claude-plugin/plugin.json: generated from .apm/, never hand-edited. tests/ subdirectories are excluded from the mirror (dev fixtures, not host-visible runtime content; several hardcode a relative repo-root walk-up sized for the .apm/-nested depth, which breaks when duplicated one level shallower). Applied for real across all 6 plugins and verified two ways: `claude plugin validate --strict` passes on every real plugin directory, and a live `claude --plugin-dir <path> -p "list skills/agents"` behavioral test confirms content is now actually discovered. Also, from the same issue #90 review round: - scripts/check-manifests.sh pointed at each plugin's root-level plugin.json (checking skills/hooks/mcpServers/agents pointer fields) -- that file was a stale near-duplicate of .claude-plugin/plugin.json nothing else read or wrote, now deleted across all 6 plugins. check-manifests.sh is rewritten to validate .claude-plugin/plugin.json instead, and drops the pointer-field checks entirely (nothing to check -- those fields are correctly absent by design). Content-presence drift is now check-plugin-content-sync's job, a new pre-push hook wired in .pre-commit-config.yaml. docs/adr/0017 records the root cause and decision in full, including two rejected alternatives (patching plugin.json's path fields directly -- apm's compiler strips them on every run; pointing marketplace.json at apm pack's build/ output -- a version-suffixed non-source directory nothing can install from without an extra build step). ADR-0015 and CONTEXT.md are updated to point at it. Refs: #90
78 lines
3.1 KiB
Markdown
78 lines
3.1 KiB
Markdown
# CONTEXT.md Format
|
|
|
|
## Structure
|
|
|
|
```md
|
|
# {Context Name}
|
|
|
|
{One or two sentence description of what this context is and why it exists.}
|
|
|
|
## Language
|
|
|
|
**Order**:
|
|
{A concise description of the term}
|
|
_Avoid_: Purchase, transaction
|
|
|
|
**Invoice**:
|
|
A request for payment sent to a customer after delivery.
|
|
_Avoid_: Bill, payment request
|
|
|
|
**Customer**:
|
|
A person or organization that places orders.
|
|
_Avoid_: Client, buyer, account
|
|
|
|
## Relationships
|
|
|
|
- An **Order** produces one or more **Invoices**
|
|
- An **Invoice** belongs to exactly one **Customer**
|
|
|
|
## Example dialogue
|
|
|
|
> **Dev:** "When a **Customer** places an **Order**, do we create the **Invoice** immediately?"
|
|
> **Domain expert:** "No — an **Invoice** is only generated once a **Fulfillment** is confirmed."
|
|
|
|
## Flagged ambiguities
|
|
|
|
- "account" was used to mean both **Customer** and **User** — resolved: these are distinct concepts.
|
|
```
|
|
|
|
## Rules
|
|
|
|
- **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others as aliases to avoid.
|
|
- **Flag conflicts explicitly.** If a term is used ambiguously, call it out in "Flagged ambiguities" with a clear resolution.
|
|
- **Keep definitions tight.** One sentence max. Define what it IS, not what it does.
|
|
- **Show relationships.** Use bold term names and express cardinality where obvious.
|
|
- **Only include terms specific to this project's context.** General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
|
|
- **Group terms under subheadings** when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.
|
|
- **Write an example dialogue.** A conversation between a dev and a domain expert that demonstrates how the terms interact naturally and clarifies boundaries between related concepts.
|
|
|
|
## Single vs multi-context repos
|
|
|
|
**Single context (most repos):** One `CONTEXT.md` at the repo root.
|
|
|
|
**Multiple contexts:** A `CONTEXT-MAP.md` at the repo root lists the contexts, where they live, and how they relate to each other:
|
|
|
|
```md
|
|
# Context Map
|
|
|
|
## Contexts
|
|
|
|
- [Ordering](./src/ordering/CONTEXT.md) — receives and tracks customer orders
|
|
- [Billing](./src/billing/CONTEXT.md) — generates invoices and processes payments
|
|
- [Fulfillment](./src/fulfillment/CONTEXT.md) — manages warehouse picking and shipping
|
|
|
|
## Relationships
|
|
|
|
- **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
|
|
- **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate invoices
|
|
- **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`
|
|
```
|
|
|
|
The skill infers which structure applies:
|
|
|
|
- If `CONTEXT-MAP.md` exists, read it to find contexts
|
|
- If only a root `CONTEXT.md` exists, single context
|
|
- If neither exists, create a root `CONTEXT.md` lazily when the first term is resolved
|
|
|
|
When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.
|