Правилен начин за отворање на CLAUDE.md

CLAUDE.md е специјална датотека што се наоѓа во коренскиот директориум на проектот и служи за да му даде на AI асистентот (како Claude) клучни информации за вашиот проект. Со добро напишана датотека, AI може подобро да го разбере и да ви помогне.

Зошто е потребен CLAUDE.md?

Замислете дека имате нов колега и колку време ви е потребно за да го разбере вашиот проект? CLAUDE.md е тој „прирачник за проектот“ што му овозможува на AI брзо да започне.

Петте основни содржини на CLAUDE.md

1. Преглед на проектот

Едноставно опишете што прави овој проект, кој проблем го решава и за кои корисници е наменет.

# Преглед на проектот Ова е систем за управување со е-трговија, кој се користи за управување со производи, нарачки и корисници.

2. Технички стек

Наведете ги главните технологии и рамки што се користат во проектот.

`# Технички стек

• Преден дел: React + TypeScript
• Заден дел: Node.js + Express
• База на податоци: PostgreSQL
• Распоредување: Docker + Kubernetes`

3. Структура на датотеки

Објаснете ја улогата на главните директориуми.

# Структура на датотеки /src /components - UI компоненти /pages - Страници /utils - Функции за помош /api - API повици

4. Често користени команди

Наведете ги често користените команди во развојот.

# Често користени команди npm run dev - Стартувај сервер за развој npm run build - Изгради продукциска верзија npm run test - Изврши тестирање

5. Правила

Дефинирајте ги правилата што AI треба да ги следи кога ви помага да пишувате код.

`# Правила за кодирање

• Користете функционални компоненти
• Следете ја конфигурацијата на ESLint
• Користете PascalCase за именување на компоненти
• Користете camelCase за именување на променливи`

Целосен пример

`# Име на проект: Task Manager

Преглед на проектот

Едноставна апликација за управување со задачи, која поддржува креирање, уредување, бришење и категоризација на задачи.

Технички стек

• React 18
• TypeScript
• Tailwind CSS
• Vite

Структура на датотеки

/src /components - UI компоненти /hooks - Прилагодени Hooks /types - TypeScript дефиниции на типови /utils - Функции за помош

Често користени команди

• npm run dev: Стартувај сервер за развој
• npm run build: Изгради продукциска верзија
• npm run lint: Проверка на код

Стандарди за кодирање

• Користете функционален стил за компонентите
• Користете Tailwind CSS за стилизирање
• Секоја компонента ставете ја во посебна папка`

Совети

• Бидете концизни: Не пишувајте премногу долго, AI исто така може да се „умори“
• Редовно ажурирајте: Запомнете да го ажурирате CLAUDE.md кога проектот се менува
• Приоритет на примери: Давањето конкретни примери на код е поефикасно од апстрактни описи
• Фокусирајте се на проблемите: Нагласете ги областите каде што лесно може да се направат грешки

Напишете добар CLAUDE.md и дозволете AI да стане ваш корисен асистент!