Repository navigation
docs: document the agent hooks and their trust requirement - #38
Merged
Merged
Conversation
- Describe the shared format-on-edit hook and the Claude Code and Codex configuration files in the generated project's README - State that both tools apply the configuration only in a trusted project, and that Codex additionally needs the hook trusted through /hooks before it runs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview and Background
The generated project's README now describes the agent configuration shipped in #37 and states what a user must do before it takes effect. Verifying the Codex path end to end showed that Codex loads project hooks only when the
.codex/layer is trusted and the hook definition itself has been reviewed and trusted through/hooks; until then it skips the hook without printing an error. A first Codex run in a fresh generated project therefore left an unformatted file behind with no indication why. The generated README also did not mention the hook or the settings files at all.Related Issues
None. Documents the configuration added in #37.
Implementation Approach
Documentation only. The generated README gains an "AI Coding Agents" section listing the three files and the trust requirement for each tool; the repository README gets the same trust note appended to its existing file list. No behavior changes, because the trust step is a deliberate safety mechanism in both tools and cannot be waived from the project side.
Changes
template/README.md: new "AI Coding Agents" section (files,.claude/settings.local.jsonfor personal overrides, trust requirements for Claude Code and Codex).README.md: trust note added to the existing AI Editor Support list.Impact
copier updatethree-way merge.Validation Results
Behavior that motivated the change, observed in a project generated from
main:Rendered the README from this branch with
copier copyand confirmed the new section appears with no unrendered Jinja.