Skip to content

docs(hooks): add event vocabulary mapping README (#672)#1998

Merged
sjarmak merged 1 commit into
gastownhall:mainfrom
Rome-1:fix/hooks-event-vocabulary-mapping
May 13, 2026
Merged

docs(hooks): add event vocabulary mapping README (#672)#1998
sjarmak merged 1 commit into
gastownhall:mainfrom
Rome-1:fix/hooks-event-vocabulary-mapping

Conversation

@Rome-1
Copy link
Copy Markdown
Contributor

@Rome-1 Rome-1 commented May 11, 2026

Summary

Closes Gap 5 of the non-Claude provider parity audit (wasteland w-c243404137 / gastownhall/gascity#672 / audit doc at Rome-1/gastown).

The audit flagged that each provider's hook config uses different event naming (Claude PreCompact, Gemini PreCompress, Cursor preCompact, OpenCode session.compacted, OMP/Pi session.compacted) with no central document mapping them — making omissions invisible at review time. This README is the docs-only half of the fix.

Changes

New file internal/hooks/config/README.md containing:

  • File layout noteclaude.json lives in internal/hooks/config/; every other provider lives in internal/bootstrap/packs/core/overlay/per-provider/<provider>/… (codex, cursor, copilot, gemini, opencode, omp, pi all have their hook configs scoped under their expected dotfile path).
  • Mapping table of Gas City's canonical events (session start, pre-compaction, user prompt submit, before agent run) to the native name each provider uses, with a ✓/— column per provider.
  • Command bindings for each canonical event (gc prime, gc handoff, gc nudge/gc mail) so future contributors do not have to dig through config files to learn the contract.
  • Procedure for adding a new provider hook.
  • Known gaps section that surfaces the copilot pre-compaction gap (Review and action non-Claude provider parity audit report #672 gap 3, bead ga-10l) so it stays visible until closed.

No code changes; docs-only.

Closes ga-4lb (Gap 5 of #672).

🤖 Generated with Claude Code

@github-actions github-actions Bot added the status/needs-triage Inbox — we haven't looked at it yet label May 11, 2026
@randy-release-manager randy-release-manager Bot added kind/chore Internal improvement (refactor, tests, CI, tooling) priority/p3 Backlog — good idea, reviewed when there's bandwidth and removed status/needs-triage Inbox — we haven't looked at it yet labels May 12, 2026
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 73.68421% with 5 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
cmd/gc/doctor_v2_checks.go 73.68% 4 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!

@julianknutsen julianknutsen added status/needs-review-auto PR review requested with auto approval status/reviewing and removed status/needs-review-auto PR review requested with auto approval labels May 13, 2026
@julianknutsen
Copy link
Copy Markdown
Collaborator

Preflight blocked: the PR description says this is docs-only, but the branch also includes a separate code fix commit (fix(doctor): wire --fix to migrate legacy v1 pack shape) and changes to cmd/gc/doctor_v2_checks.go plus cmd/gc/doctor_v2_checks_test.go. Please split the code fix into a separate PR or update the PR scope/body so the story matches the actual diff.

@julianknutsen julianknutsen added the status/needs-info Waiting on you — please reply label May 13, 2026
Closes Gap 5 of the non-Claude provider parity audit (wasteland
w-c243404137 / gastownhall#672 / audit doc
docs/research/w-7ed35a727f-parity-audit-classification.md). The audit
flagged that each provider's hook config uses different event naming
(Claude PreCompact, Gemini PreCompress, Cursor preCompact, OpenCode
session.compacted, OMP/Pi session.compacted) with no central document
mapping them — making omissions invisible at review time.

Add internal/hooks/config/README.md with:

- File layout note (claude lives here; everything else lives in
  internal/bootstrap/packs/core/overlay/per-provider/<provider>/).
- Mapping table of Gas City's canonical events (session start,
  pre-compaction, user prompt submit, before agent run) to the native
  name each provider uses, with a ✓/— column per provider.
- The command bindings for each canonical event (gc prime, gc handoff,
  gc nudge/gc mail) so future contributors do not have to dig through
  config files to learn the contract.
- Procedure for adding a new provider hook.
- "Known gaps" section that surfaces the copilot pre-compaction gap
  (gastownhall#672 gap 3 / bead ga-10l) so it stays visible until closed.

No code changes. Docs-only.

Closes ga-4lb.
@Rome-1 Rome-1 force-pushed the fix/hooks-event-vocabulary-mapping branch from 307d6bb to e1b3ab8 Compare May 13, 2026 07:37
@Rome-1
Copy link
Copy Markdown
Contributor Author

Rome-1 commented May 13, 2026

Thanks @julianknutsen — split the doctor --fix commit out into #2058. This branch now contains only the docs commit (307d6bbe1b3ab8 after the rebase), matching the PR description.

@github-actions github-actions Bot removed the status/needs-info Waiting on you — please reply label May 13, 2026
@sjarmak sjarmak merged commit caa44a4 into gastownhall:main May 13, 2026
58 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/chore Internal improvement (refactor, tests, CI, tooling) priority/p3 Backlog — good idea, reviewed when there's bandwidth status/reviewing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants