docs(framework): hooks documentation, tool-internal vs pre-commit
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 68/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- git, javascript
- Lĩnh vực
- documentation
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- TypeScript
- Star
- 481
- Fork
- 45
- Merge trung bình
- 19 giờ 38 phút
- Pull request đã merge (30 ngày)
- 108
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của ai-driven-dev/framework
-
refactor(aidd-orchestrator): the check zone says when to stop, and reviews its axes in one round Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
ai-driven-dev/framework#887 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
ai-driven-dev/framework#873 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
ai-driven-dev/framework#872 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
ai-driven-dev/framework#625 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
ai-driven-dev/framework#467 · 1 bình luận ·
Tất cả issue của ai-driven-dev/framework
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
mksglu/context-mode#1200 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
jaegertracing/jaeger-ui#4506 ·
-
area:desktop area:ui bug platform:macos
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
anthropics/claude-code#96687 ·
-
good first issue
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 95/100
AOSSIE-Org/DebateAI#582 · 2 bình luận ·