Thread
A good CLAUDE .md file is a huge unlock for our friends Claude Code, Cursor, Gemini, etc. Here's ours. Some notes: • First, we situate the agent with basic context by explaining the what and why of the app. • Next, we explain how to do basic development tasks: add packages, run tests, etc. • Next, we explain how any MCP servers should be used. We only use one: Playwright. We've found it to be invaluable for helping Claude make progress on tricky UI tasks. More on this later. On to the next page below...
In the second half of our CLAUDE .md file, we continue explaining the how and where of our app. • Debugging is like half the job, so we explain how to do it well. • We then give the bird's eye view of the business logic, and point to several files that are its cornerstones. We also point out files that representative of our favorite patterns. Claude will not read these right away, but will know what to consult when needed. • Lastly, we state our preference for less comments and more simply giving things clear names
And that's it. The shorter, the better, as context is still precious. AI agents now write most of the code of our app superconductor.dev But this is only possible with clear guidance from experienced devs, which starts with CLAUDE .md. Would be curious to see yours!
Made with Bullet