@aperant/framework 0.6.4 → 0.6.5

package/templates/context-format.md

@@ -0,0 +1,34 @@
+<!--
+Adapted from Matt Pocock's MIT-licensed skill suite:
+https://github.com/mattpocock/skills/blob/main/skills/engineering/grill-with-docs/CONTEXT-FORMAT.md
+Licensed under MIT. Modifications: ported as the Aperant CONTEXT.md
+template emitted by `apt-tools context write`. Adds the "Project glossary"
+header and example dialogue section.
+-->
+
+# Project glossary (CONTEXT.md)
+
+This file is the persistent project glossary. Each term-block carries the
+following fields per Pocock's CONTEXT.md format:
+
+- **{Term}** — definition (one line).
+  - **Aliases to avoid:** comma-separated synonyms or near-synonyms that
+    should NOT be used interchangeably. Prevents conflated-terminology
+    bugs that no amount of code review catches.
+  - **Cardinality:** one-to-one, one-to-many, many-to-many. When the
+    term refers to an entity, this is the relationship to its parent or
+    children.
+  - **Flagged ambiguities:** any known gray areas where the term is used
+    inconsistently in the codebase. Resolving these is part of the
+    grill loop.
+  - **Example dialogue:** a 1-2 turn example showing how the term is
+    used in a sentence (or in a UI label, error message, API field
+    name). Anchors the term to surface usage.
+
+`apt-tools context write` upserts term-blocks into this file. The writer
+is idempotent — re-running with the same `--term` overwrites the
+existing block in place. Fields not explicitly overridden are preserved.
+
+The format intentionally mirrors a domain glossary, not a code glossary.
+Terms are user-facing concepts (e.g., "Plan thread", "Sparring round"),
+not implementation details (e.g., "ChatSession", "useTaskStore").