Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.3 KB

AGENTS.md

File metadata and controls

30 lines (20 loc) · 1.3 KB

agent guidelines

writing style

  • keep the tone casual and nonchalant, lowercase everything
  • avoid words that sound try-hard or cringe (e.g. "shoutout", "collab", "awesome")
  • use dashes for pauses, write like you're just talking
  • match the existing vibe of the repo's README.md

raw inputs

  • every design document folder should have a raw.mdx file that contains the unedited raw inputs provided by the user
  • this is for transparency- an open look at how the ideas were communicated before being cleaned up
  • always create and update this file when writing or updating the design document sections
  • every time new inputs are provided in a conversation, append them to the raw.mdx file for that design document- don't skip this across any interaction

model attribution

  • when referencing the ai model used, use the general name (e.g. "Claude") not the specific model id (e.g. not "claude-sonnet-4-6" or "Claude Opus 4.6")
  • keep it simple and casual- just say claude, not the versioned name

diagrams

  • any diagrams in design documents should be written in mermaid
  • don't use images or ascii art for diagrams- keep it all in mermaid blocks

pull requests

  • do not mention that content was generated by claude code in the pr body
  • co-author tags in commits are fine, just keep it out of the pr description