Skip to content

AGENTS.md

Latest commit

 

History

History
38 lines (26 loc) · 1.53 KB

AGENTS.md

File metadata and controls

38 lines (26 loc) · 1.53 KB
Raw

Beads Pi

An extension for pi to manage tasks via beads.

Code style

  • Where appropriate try to abstract code into helper functions and sometimes potentially helper objects. The resulting extension code should live on the same layer of abstraction and be elegant to read for intuitive understanding.

Task Management

Use bd (beads) for task tracking.

  • When creating or updating issues with multi-line descriptions, use actual newlines in the shell command (not \n).
  • Use p2 as default priority unless context gives another impression.

Key commands:

  • bd ready --sort priority --json -- see unblocked work at session start
  • bd list --status open --json -- list all open issues
  • bd show <id> --json -- show issue details
  • bd update <id> -s in_progress --json -- mark a task as started
  • bd close <id> -r "reason" --json -- close a completed task
  • bd create "title" -t task --json -- create a new task
  • bd sync -- sync issues to git before ending a session

When closing a beads task, use a conventional commit so it appears in the changelog (e.g. fix:, feat:, refactor:).

Releasing

Uses release-it with @release-it/conventional-changelog to auto-generate CHANGELOG.md from conventional commits.

npm run release:dry -- patch    # preview a patch release
npm run release -- patch        # 0.2.0 → 0.2.1
npm run release -- minor        # 0.2.0 → 0.3.0
npm run release                 # interactive prompt to pick version

Omitting the version argument gives an interactive picker. Always dry-run first.