Skip to content

AGENTS.md

Latest commit

 

History

History
42 lines (25 loc) · 1.36 KB

AGENTS.md

File metadata and controls

42 lines (25 loc) · 1.36 KB
Raw

Agent Instructions

Keep this project as agent-agnostic as possible.

Rule: Context Maintenance

At the end of every significant task or session, summarize the current state, architectural decisions made, and pending "todo" items into AGENTS.md. Always ensure this file reflects the "ground truth" of the project so future sessions can resume without friction. Use the writeFile tool to overwrite it so the next session starts with current state.

Rule: Commits

  • Always use conventional commits (e.g. feat:, fix:, docs:, chore:)
  • Never add anything agent related (copilot, claude, etc.) to commit messages or co-authorship
  • Committing directly to main is okay in this repo

Rule: Environment

  • Use /usr/bin/open (full path) to open files or URLs on macOS — never plain open

Rule: Secrets

  • Never commit secrets, config files, or database files

Rule: Code style

  • Single-line paragraphs in all markdown files — no multi-line wrapped paragraphs
  • No underscores or spaces in filenames; use hyphens
  • No extensions on executable scripts, ever
  • In Go bonzai.Cmd structs, always put Long last so code is easier to read
  • Cmd.Short must always be less than 50 runes
  • Always add help.Cmd as the first bonzai subcommand

Rule: Agent specific

  • Always use gh copilot not copilot

Current architecture

TODO

Current tags / versions

TODO