docs(framework): write the hook contract in docs/ARCHITECTURE.md
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 78/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- typescript
- Domínio
- documentation
Direção de pesquisa
Leia as regras 5 e 7 em docs/ARCHITECTURE.md e, em seguida, encontre a referência a 08-hook-generate e o contrato anterior do hook na PR #1158. Adicione a seção de contrato solicitada e alinhe essas regras a ela; a tabela de compatibilidade por ferramenta está fora do escopo. O trabalho estará concluído quando os três critérios de aceitação forem atendidos.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Problem
Hooks the framework ships must behave the same on every supported tool. The contract lives in PR #1158 and in session notes, not in one place a hook author or the hook generator can follow. Two hooks written without it already disagree (#1190).
Scope
Add a short section to docs/ARCHITECTURE.md:
- A hook is a script: deterministic, no model, no network, 5 s timeout, one purpose.
- Two reactions: inform (
additionalContext) or require (decision: "block"with areason). Say nothing when there is nothing to report. - Shared moments:
SessionStart,PostToolUse,Stop. Optional where the tool has them:PreToolUse,UserPromptSubmit,SubagentStop. - Rules: judge only what changed this turn (sha1 baseline of the relevant files, not a tool-name filter); report only new findings; require nothing that cannot be done yet; require at most once per turn, tracked in the script; neutral message that says what to do; git read-only; no state outside the script's own baseline file.
- Scope statement: hooks a user generates for one tool with
08-hook-generateare not bound by this contract.
Per-tool facts go to COMPATIBILITY.md (#978), not here.
Acceptance criteria
- The section exists in
docs/ARCHITECTURE.md. -
08-hook-generatereferences it. - Rules 5 and 7 of
ARCHITECTURE.mdare consistent with it.
Prior art in this repo
- #1158 (one hook contract), #1146 (git allowed read-only), #1190 (plan check false positives), #978 (verified compatibility).
Out of scope
The per-tool table (#978). Bridge fixes (#1191, #1193, #1194).
- Linguagem predominante
- TypeScript
- Estrelas
- 481
- Forks
- 45
- Merge médio
- 1d 13h
- PRs com merge (30d)
- 91
Preparar o ambiente
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de ai-driven-dev/framework
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 86/100
ai-driven-dev/framework#1311 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 79/100
ai-driven-dev/framework#1244 ·
Mantenedores costumam responder em até 1 dia
-
refactor(aidd-context): apply the new skill template to learnTalvez já em andamento @blafourcade assumiu há 2 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
ai-driven-dev/framework#1186 · 1 responsável ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 83/100
ai-driven-dev/framework#1163 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
ai-driven-dev/framework#1162 ·
Mantenedores costumam responder em até 1 dia
Todas as issues de ai-driven-dev/framework
Issues semelhantes
-
bug impact:low Team: SecuritySolution Team:Defend Workflows v9.6.0
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
elastic/kibana#306401 · 3 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
agentes-chat/agentes-chat#927 ·
Mantenedores costumam responder em até 1 dia
-
[Bug]: Webapp workspace fails to render in Safari — "Can't find variable: requestIdleCallback"Abertacomp/desktop P2 type/bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
NousResearch/hermes-agent#157702 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
Mantenedores costumam responder em até 1 dia
-
e2e-failure ready-to-code
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 72/100
redhat-developer/rhdh-plugin-export-overlays#4794 · 1 comentário ·
Mantenedores costumam responder em até 1 dia