Files
bookshelf/AGENTS.md

1.2 KiB

Agent Instructions

Read docs/overview.md once at the start of each session before doing anything else.

Communication

  • Brief, technical only — no preambles, no summaries.

Implementation rules

  • No backward-compatibility shims or legacy endpoint aliases.
  • Run poetry run presubmit before finishing any task. Fix all failures before marking work done.
  • Before marking a task done: update docs/overview.md if the change affects architecture, layer boundaries, config schema, directory layout, API endpoints, or the plugin system. Do not update it for implementation details.

Git rules

  • Never set or modify git config (git config or git -c user.*) without an explicit request from the user.
  • Respect whatever author/email is already configured in the repository or global git config.
  • If a commit requires author information that is missing, ask the user rather than inventing values.

Documentation rules

Follow docs/contributing.md. Key points:

  • Prefer in-code comments and self-documenting code over external docs.
  • Add docstrings only to public functions you create or modify; Google style.
  • Update docs/overview.md only for structural/architectural changes, not implementation details.
  • No emojis in any documentation.