docs(framework): hooks documentation, tool-internal vs pre-commit
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- git, javascript
- Domain
- documentation
Research direction
Start with the bundled-hooks section in docs/ARCHITECTURE.md, then review docs/CREATE_PLUGIN.md and docs/GLOSSARY.md alongside the documented Context, Telemetry, OpenCode, and Claude Code hook references. Update the three named documents so the authoring contract, lifecycle and host coverage, and agent-hook versus Git pre-commit boundary are explicit, and confirm every acceptance criterion is met.
Written by the indexing model from the issue text.
Description
Problem
The framework ships bundled hooks, but authors lack one documented, host-aware contract for adding a hook.
Scope
- Extend the existing bundled-hooks section in
docs/ARCHITECTURE.mdwith the minimal hook contract, supported lifecycle mapping, and the boundary with Git hooks. - Link that section from
docs/CREATE_PLUGIN.md. - Correct
docs/GLOSSARY.md: Git pre-commit is not an agent lifecycle event.
Acceptance criteria
- An author can add a basic hook from
ARCHITECTURE.mdwithout reading an existing implementation. - Supported lifecycle events and per-host coverage are explicit.
- The agent-hook versus Git-pre-commit boundary is explicit.
-
CREATE_PLUGIN.mdlinks to the authoritative section. - The glossary no longer classifies pre-commit as an agent lifecycle event.
Prior art in this repo
ARCHITECTURE.mdalready inventories Context and Telemetry hooks, but does not define an authoring contract.- Context and Telemetry have declarative hooks; OpenCode uses a JavaScript plugin bridge.
- Claude Code Hooks documents more events than AIDD currently normalizes.
Out of scope
- Changing or adding a bundled hook.
- Installing Git pre-commit hooks or adding CI enforcement.
- Claiming lifecycle parity that a host has not demonstrated.
- Dominant language
- TypeScript
- Stars
- 481
- Forks
- 45
- Avg merge
- 19h 38m
- Merged PRs (30d)
- 108
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ai-driven-dev/framework
-
refactor(aidd-orchestrator): the check zone says when to stop, and reviews its axes in one round Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ai-driven-dev/framework#887 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
ai-driven-dev/framework#873 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
ai-driven-dev/framework#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
ai-driven-dev/framework#625 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ai-driven-dev/framework#467 · 1 comment ·
All issues in ai-driven-dev/framework
Similar issues
-
VerificationGate: ATTRIBUTION quote guard never matches a normal quotation (\b around the quote) Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
danielmiessler/LifeOS#2234 ·
-
T: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Mend: dependency security vulnerability untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 70/100