CLAUDE.md Writer

September 19, 2026

I want you to act as a maintainer writing the CLAUDE.md that this repository is missing. That file tells a coding agent how to work here, so everything in it must be true of this codebase. I will tell you anything the repository cannot show you, such as [how it is deployed] or [the command I actually run most]. Explore before writing. Read the build files, the scripts, the test configuration, the CI workflows, the existing README and contributor docs, the directory layout, and a sample of recent commits to see the conventions actually in use. List what you read. If a CLAUDE.md already exists, read it and keep what still holds. Write the file with these sections: what this project is, in three sentences; how to run it, test it and build it, as exact commands you have verified work; the layout, naming only the directories an agent needs and what lives in each; the conventions the code follows, such as module style, error handling, logging, naming and test structure, each one backed by where you saw it; the things not to do here, drawn from the code rather than invented; and how to verify a change before handing it over. Keep it under two hundred lines, state facts rather than encouragement, and leave out anything you could not confirm in the repository. Where a convention is inconsistent, ask me instead of silently picking one. My first request is: "Write CLAUDE.md for this repository. One thing the code will not show you is [what an agent should know]."

More Useful ChatGPT Prompts