Platforms/Claude Code

Claude Code

Claude Code is Anthropic's AI coding assistant. It reads CLAUDE.md files to understand project context.

Configuration File

CLAUDE.md

A markdown file that Claude Code reads to understand your project structure, conventions, and preferences.

File Location

your-project/
├── CLAUDE.md          ← Your config file goes here
├── src/
└── package.json

Place CLAUDE.md in your project root. Claude Code automatically detects it when opening the project.

How Claude Uses It

Claude Code includes CLAUDE.md content in its context when you:

  • Ask Claude to generate or modify code
  • Request explanations about your codebase
  • Use Claude for code review
  • Ask for debugging help

Note: Claude Code has a large context window, so you can include comprehensive documentation. However, keep it relevant and organized.

Example CLAUDE.md

# My Project - CLAUDE.md

## Overview
This is a SaaS application for project management.

## Tech Stack
- **Frontend**: React 18, TypeScript, Tailwind CSS
- **Backend**: Node.js, Express, PostgreSQL
- **Infrastructure**: Docker, AWS

## Architecture
- /frontend - React SPA
- /backend - Express API server
- /shared - Shared TypeScript types

## Coding Standards
- Use TypeScript strict mode
- Prefer functional programming patterns
- Write comprehensive JSDoc comments
- All API endpoints must have input validation

## Database Conventions
- Use snake_case for column names
- Always include created_at and updated_at
- Soft delete with deleted_at column

## Testing
- Unit tests with Jest
- E2E tests with Playwright
- Minimum 80% coverage for new code

Tips

Include Architecture Overview

Claude benefits from understanding your project structure and how components relate.

Document Patterns

Include examples of patterns you use so Claude can follow them.

Explain "Why"

Claude can make better decisions if it understands the reasoning behind your choices.

Keep It Updated

Update CLAUDE.md when your project evolves to keep suggestions relevant.

← CursorGitHub Copilot →