docs(hooks): add event vocabulary mapping README (#672)#1998
Merged
sjarmak merged 1 commit intoMay 13, 2026
Conversation
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
Collaborator
|
Preflight blocked: the PR description says this is docs-only, but the branch also includes a separate code fix commit ( |
3 tasks
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.
307d6bb to
e1b3ab8
Compare
Contributor
Author
|
Thanks @julianknutsen — split the doctor |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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, GeminiPreCompress, CursorpreCompact, OpenCodesession.compacted, OMP/Pisession.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.mdcontaining:claude.jsonlives ininternal/hooks/config/; every other provider lives ininternal/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).gc prime,gc handoff,gc nudge/gc mail) so future contributors do not have to dig through config files to learn the contract.No code changes; docs-only.
Closes ga-4lb (Gap 5 of #672).
🤖 Generated with Claude Code