-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Problem
The hooks example in frontmatter-requirements.md shows basic hook structure but omits the timeout option:
hooks:
- event: "AgentStart"
command: "./scripts/prepare-agent.sh"
description: "Prepare the agent environment"Users may not realize timeout is configurable and important for long-running hooks.
Solution
Expand the example to include timeout:
hooks:
- event: "AgentStart"
command: "./scripts/prepare-agent.sh"
description: "Prepare the agent environment"
timeout: 10000 # 10 seconds (default: 5000ms)Add a note explaining timeout behavior:
**Timeout:** Hooks have a default timeout of 5 seconds. For longer operations:
- Set explicit `timeout` in milliseconds
- Consider async patterns for very long operations
- Hooks that timeout are treated as failures (may block the operation)Files to Update
references/frontmatter-requirements.md
Impact
- Priority: Low
- Effort: Low
- User Impact: Prevents unexpected hook failures from timeouts
Review context: commit f2fe29b (agent hooks documentation)
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request