From 1a5c515ca8f0be42503c4bb3f30349a34b8add52 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 6 Jan 2026 19:20:38 +0000 Subject: [PATCH] docs: formalize PR review/landing workflow --- AGENTS.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 0c2e33ee0..56404115f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,7 +6,9 @@ - Docs: `docs/` (images, queue, Pi config). Built output lives in `dist/`. ## Build, Test, and Development Commands +- Runtime baseline: Node **22+** (keep Node + Bun paths working). - Install deps: `pnpm install` +- Also supported: `bun install` (keep `pnpm-lock.yaml` + Bun patching in sync when touching deps/patches). - Prefer Bun for TypeScript execution (scripts, dev, tests): `bun ` / `bunx `. - Run CLI in dev: `pnpm clawdbot ...` (bun) or `pnpm dev`. - Node remains supported for running built output (`dist/*`) and production installs. @@ -39,6 +41,10 @@ - When merging a PR: leave a PR comment that explains exactly what we did. - When merging a PR from a new contributor: add their avatar to the README “Thanks to all clawtributors” thumbnail list. +### PR Workflow (Review vs Land) +- **Review mode (PR link only):** read `gh pr view/diff`; **do not** switch branches; **do not** change code. +- **Landing mode:** create an integration branch from `main`, merge PR head into it, apply fixes, add changelog (+ thanks + PR #), commit, merge back to `main`, then `git switch main` (never stay on a topic branch after landing). + ## Security & Configuration Tips - Web provider stores creds at `~/.clawdbot/credentials/`; rerun `clawdbot login` if logged out. - Pi sessions live under `~/.clawdbot/sessions/` by default; the base directory is not configurable.