Skip to content

AGENTS.md

Latest commit

 

History

History
56 lines (33 loc) · 3.04 KB

AGENTS.md

File metadata and controls

56 lines (33 loc) · 3.04 KB

Repository Guidelines

Tooling

Package manager: npm workspaces (root package.json declares "workspaces": ["packages/*"]).

Runtime: Node (ESM only, "type": "module").

Language: TypeScript with strict: true, module: NodeNext. Each package has a tsconfig.build.json (emits dist/) and a tsconfig.json (noEmit, includes src + test).

Linter / formatter: Biome (biome.json at root). npm run lint / npm run lint:fix.

Test runner: Vitest (vitest run). Per-package: npm test --workspace <name>. All packages: npm test.

Releases: Changesets (.changeset/). Author a changeset with npm run changeset; publish via npm run changeset:publish. Base branch: main. Default access: public.

Workspace scripts (root): build, test, clear, lint, lint:fix — all fan out to packages via npm run <name> --workspaces --if-present.

Packages

  • @paleo/docmap — lightweight documentation system for AI agents and humans
  • @paleo/openclaw-channel-mock-core — shared library for synthetic OpenClaw channel plugins (bus, actions, factories)
  • @paleo/openclaw-slack-mock — Slack-shaped channel plugin for test scenarios
  • @paleo/openclaw-discord-mock — Discord-shaped channel plugin for test scenarios
  • @paleo/openclaw-test — Dockerised regression-test harness (bus, scenario driver, judge, Compose stack)
  • @paleo/workspace — run multiple git-worktree dev environments side by side

Docmap - Seek Documentation

Before any investigation or code exploration, run npm run docmap to list the documentation index. This is mandatory for every task — do not skip it. Browse subdirectories or read files by passing them as arguments (npm run docmap -- topic-a docs/topic-b/doc.md), or list everything (npm run docmap -- --recursive).

AlignFirst - Ticket ID, Commit Message, Branch Name

Ticket ID: Format is numeric. Use the ticket ID if explicitly provided. Otherwise, deduce it from the current branch name (no confirmation needed). If the branch name is unavailable, get it via git branch --show-current. Only ask the user as a last resort.

Commit message convention: we use conventional commit, e.g., feat: [#123] add new feature. Always prefix the ticket ID with a # sign. Do not add a "Co-Authored-By:" line.

Branch naming convention: <type>/<ticket-id> (with type from conventional commit, e.g., feat/123, fix/123, refactor/123, chore/123).

Add paleo-typescript-style skill to every plan.

Coding rules

Apply the paleo-typescript-style skill.

  • Use UTF-8 encoding with 2-space indentation, 100-char line width.
  • Use the semicolon syntax.
  • Prefer double quotes ".

Guidelines when writing markdown files

  • Important: Use sharp, precise, concise words, straight to the point. The less, the better. Make each word count.
  • Do not fill the context with bloated orders.
  • Do not treat the agent like a child; no need to be insistent and authoritarian. Make what is important more obvious.

Writing Markdown: Do not wrap text to 80 chars; let it run freely.