chore: add just task runner and adopt AGENTS.md conventions - #7
Merged
Conversation
Port the planbridge task-runner convention to this repo. `just verify` becomes the canonical full-check entrypoint (format:check, typecheck, lint, test) and is what agents run before marking work complete. Other recipes (install, bootstrap, run, build, dev, storybook) wrap existing package.json scripts, and a release.just mod adds a goreleaser dry-run. Pin just in .tool-versions alongside bun.
Make AGENTS.md the canonical project doc (overview, layout, verification, PR rules, conventions linking every .claude/rules file) and reduce CLAUDE.md to an `@AGENTS.md` stub, matching planbridge. Add a tailored CONTRIBUTING.md for the dev/test/release workflow and refocus README on CLI consumers, pointing contributors to CONTRIBUTING.md.
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
1 participant
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.
Summary
Ports a few conventions from the sibling
planbridgerepo, tailored to this single-package layout. Adds ajusttask runner whosejust verifyrecipe (format → typecheck → lint → test) is the canonical full-check entrypoint agents run before completing work, plusrun/build/dev/storybook/bootstraprecipes and arelease dry-run. MakesAGENTS.mdthe canonical project/agent doc withCLAUDE.mdreduced to an@AGENTS.mdstub, adds aCONTRIBUTING.md, and refocusesREADME.mdon CLI consumers.Review focus
AGENTS.mdas canonical,CLAUDE.mdas an@AGENTS.mdstub. This moves the always-loaded Bun boilerplate out ofCLAUDE.mdand relies on the conventions instead living in the linked.claude/rules/*files (loaded on matching edits) plus the existing Cursor.mdc. Worth confirming nothing important got dropped from the oldCLAUDE.mdin the process.justis now required for the README "From source" path (just install+just run). It's pinned in.tool-versions, but it does add a dependency to a path a consumer might take. Thejust run -- --helpform survives thejust → bun run start(compound&&script) chain — verified--helpreaches the CLI rather than being demoted to a positional byparseArgs.Commits
0b8f989— chore: add just task runner with verify/build/release recipesfc0f03c— docs: adopt AGENTS.md instructions and add CONTRIBUTING