Skip to content

Latest commit

 

History

History
12 lines (8 loc) · 840 Bytes

File metadata and controls

12 lines (8 loc) · 840 Bytes

Repository instructions

Writing

  • Always edit human-facing text before sending, saving, committing, or publishing it. This includes replies, comments, docstrings, docs, UI copy, commit messages, and PR titles and bodies.
  • Use plain language, concrete details, and direct sentences. Cut filler, canned openings, hype, repeated caveats, needless jargon, and invented compound labels. Explain what changed and why.
  • Do not use semicolons in prose or comments. Split the sentence or rewrite it. Preserve punctuation required by code, commands, data formats, and exact quotations.
  • Read the final text for clarity and accuracy. Preserve technical meaning and state testing limits plainly.

Code

For work under code/, also follow code/AGENTS.md, which routes to the relevant implementation and validation rules.