Repository navigation
docs(agents): document dogfood hook setup - #194
Open
gutierrezje wants to merge 1 commit into
Open
gutierrezje wants to merge 1 commit into
gutierrezje wants to merge 1 commit into
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This branch has not been deployed
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.
Issue
None. This is a small docs change, so the PR is its complete record.
Outcome
AGENTS.mdstops telling agents topnpm link --globala branch build. That command replaces the globaldiffowlbinary that other projects use. A new Dogfooding section documents the safe setup instead: keep the released global install, and pin this repo's post-commit hook to a dedicated worktree detached atorigin/main. Codex, Cursor, and Claude sessions all readAGENTS.md, so every agent sees the same rule.Reviewer guide
## Dogfoodingsection inAGENTS.md.pnpm link --globalcommand and the reworded Notes bullet. The old bullet assumed a linked global binary.README.md"Develop locally" still showspnpm link --global. That is reasonable for a new contributor who doesn't use DiffOwl elsewhere, so I left it alone.Verification
pnpm run check:anti-slopandoxfmt --check AGENTS.mdpass.hook installpins the CLI that ran it, for the current repo only. It usescli: fileURLToPath(import.meta.url)insrc/git/hook-installation.ts.origin/main(89a6be4, migration 008, matching the sharedstate.db) and installed the hook from it. Committing this change triggered an automatic Codex review through that build with no issues. Other projects' hooks still point at the global 0.5.2 install.Review dispositions
None.
Intentionally out of scope
README.mddevelopment instructions.Note
Low Risk
Documentation-only change to agent onboarding; no runtime or CLI behavior is modified.
Overview
AGENTS.mdnow steers agents away frompnpm link --globalon branch builds and documents a Dogfooding workflow instead.The Commands block tells contributors to run
node dist/cli.js <command>for the current checkout. The new section says to keep a released globaldiffowlfor other repos, use a dedicated worktree atorigin/mainto build and runhook install(which pins that CLI for this repo only), refresh that worktree after merges, and test unreleased migrations in a throwaway repo because worktrees share.git/hooksand.diffowl/state.db. The Notes bullet now says rebuilding is required beforenode dist/cli.jsand that the global binary and dogfood hook do not pick up branch changes.Reviewed by Cursor Bugbot for commit 5960c1d. Bugbot is set up for automated code reviews on this repo. Configure here.