Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

docs(framework): hooks documentation, tool-internal vs pre-commit

Abierto
#303 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
git, javascript

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.md with 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.md without 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.md links to the authoritative section.
  • The glossary no longer classifies pre-commit as an agent lifecycle event.

Prior art in this repo

  • ARCHITECTURE.md already 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.
Lenguaje dominante
TypeScript
Estrellas
481
Forks
45
Merge medio
19 h 38 min
PR fusionados (30 d)
108

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ai-driven-dev/framework

Todos los issues de ai-driven-dev/framework

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.