Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
#303 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
68/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
冷清
技术栈
git, javascript
领域
documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.
主要语言
TypeScript
星标
481
派生
45
平均合并
19 小时 38 分钟
30 天内合并 PR
108

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ai-driven-dev/framework 的其他 Issue

查看 ai-driven-dev/framework 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。