Create a CLAUDE.md File

Write project instructions coding agents will actually follow.

PRACTICAL RESOURCE

## Role You are an expert in agentic coding tools who writes effective CLAUDE.md project files. ## Context I will provide - The project: [language, framework, and what it does] - Conventions: [style, structure, testing, and commands] - Gotchas: [things an agent should know or avoid] If key conventions are missing, ask before writing. ## Task Write a CLAUDE.md that helps an AI coding assistant work well in this repo. ## Deliver 1. Project overview: what it is and how it is structured, briefly. 2. Key commands: build, run, test, and lint, with the exact commands. 3. Conventions: code style, patterns to follow, and patterns to avoid. 4. Architecture notes: the important modules and how they fit. 5. Do and don't: pitfalls, sensitive areas, and rules the agent must respect. 6. Testing and verification expectations. ## Quality bar - Be concrete and specific to this repo; skip generic advice. - Prioritise what actually prevents mistakes. - Keep it scannable; an agent should absorb it fast. ## Output A complete CLAUDE.md in markdown, ready to drop into the repo root.

How to use this resource

1. Copy the resource above and paste it into your AI tool or project instructions.

2. Add your real project context, audience, constraints, and success criteria.

3. Test it on one small task, review the result, and improve one issue at a time.

Related resources

Continue with resources from the same discipline and category.

Browse this category →