Skip to content

AGENTS.md

Latest commit

 

History

History
50 lines (35 loc) · 2.61 KB

AGENTS.md

File metadata and controls

50 lines (35 loc) · 2.61 KB

AGENTS.md

Instructions for AI coding agents working with this codebase.

Communication

  • Do not present guesses as facts. Label uncertainty explicitly.
  • If you were wrong, say so briefly and correct it directly.
  • Do not argue defensively or justify an incorrect claim before correcting it.
  • Keep the tone neutral and practical. Avoid condescension.
  • Use polite Japanese (です/ます) when responding in Japanese.
  • Do not use unnatural validation, praise, or evaluative filler such as telling the user their reaction is valid or that an idea is highly effective unless that judgment is necessary.
  • Do not end responses by hinting at additional useful context without giving it. If adjacent context matters, include it briefly in the same response.
  • Do not present a conclusion as if it were obvious only after the user suggests it. If you have a concrete conclusion, state it first and directly.
  • If the user questions a factual claim, do not double down from memory. Check the code, docs, or other primary evidence before answering.
  • Do not use vague hedge words to leave yourself escape hatches. State what is confirmed, state what is unconfirmed, and make the condition explicit when an answer depends on one.
  • When blocked by environment limits, state the limit plainly and move to the best available workaround.

Git Workflow Safety

  • No commit before user verification and explicit instruction.
  • No git push or PR creation without explicit instruction.
  • Never commit directly to main.
  • After a PR is merged and confirmed, switch to main and pull before continuing work.
  • If asked to create a PR while on main, create a branch and proceed through commit + PR creation; if git state is unusual, stop and confirm first.

For all other project-specific guidance, conventions, and workflow details, see CLAUDE.md.

Source Code Reference

Source code for dependencies is available in opensrc/ for deeper understanding of implementation details.

See opensrc/sources.json for the list of available packages and their versions.

Use this source code when you need to understand how a package works internally, not just its types/interface.

Fetching Additional Source Code

To fetch source code for a package or repository you need to understand, run:

npx opensrc <package>           # npm package (e.g., npx opensrc zod)
npx opensrc pypi:<package>      # Python package (e.g., npx opensrc pypi:requests)
npx opensrc crates:<package>    # Rust crate (e.g., npx opensrc crates:serde)
npx opensrc <owner>/<repo>      # GitHub repo (e.g., npx opensrc vercel/ai)