A CLAUDE.md helyes használata

A CLAUDE.md egy speciális fájl, amely a projekt gyökérkönyvtárában található, és a projekt kulcsfontosságú információit közli az AI asszisztensekkel (például Claude-dal). Ha jól megírod ezt a fájlt, az AI jobban megérti és segíteni tud neked.

Miért van szükség a CLAUDE.md-re?

Képzeld el, hogy egy új kolléga érkezik, mennyi időbe telik, mire megérti a projektet? A CLAUDE.md az a "projektleírás", amely lehetővé teszi az AI számára, hogy gyorsan bekapcsolódjon.

A CLAUDE.md öt fő tartalmi eleme

1. Projekt áttekintés

Egyszerűen írd le, hogy mit csinál ez a projekt, milyen problémát old meg, és milyen felhasználóknak szól.

# Projekt áttekintés Ez egy e-kereskedelmi háttérrendszer, amely termékek, rendelések és felhasználók kezelésére szolgál.

2. Technológiai stack

Sorold fel a projekt által használt főbb technológiákat és keretrendszereket.

`# Technológiai stack

Frontend: React + TypeScript
Backend: Node.js + Express
Adatbázis: PostgreSQL
Telepítés: Docker + Kubernetes`

3. Fájlstruktúra

Magyarázd el a fő könyvtárak szerepét.

# Fájlstruktúra /src /components - UI komponensek /pages - Oldalak /utils - Segédfüggvények /api - API hívások

4. Gyakori parancsok

Sorold fel a fejlesztés során gyakran használt parancsokat.

# Gyakori parancsok npm run dev - Fejlesztői szerver indítása npm run build - Éles verzió létrehozása npm run test - Tesztek futtatása

5. Szabályok

Definiáld azokat a szabályokat, amelyeket az AI-nek be kell tartania, amikor kódot ír neked.

`# Kódolási szabályok

Funkcionális komponensek használata
ESLint konfiguráció követése
A komponensek elnevezése PascalCase-szel
A változók elnevezése camelCase-szel`

Egy teljes példa

`# Projekt neve: Task Manager

Projekt áttekintés

Egy egyszerű feladatkezelő alkalmazás, amely támogatja a feladatok létrehozását, szerkesztését, törlését és kategorizálását.

Technológiai stack

React 18
TypeScript
Tailwind CSS
Vite

Fájlstruktúra

/src /components - UI komponensek /hooks - Egyedi Hook-ok /types - TypeScript típusdefiníciók /utils - Segédfüggvények

Gyakori parancsok

npm run dev: Fejlesztői szerver indítása
npm run build: Éles verzió létrehozása
npm run lint: Kódellenőrzés

Kódolási szabályok

A komponensek funkcionális módon íródnak
Tailwind CSS használata a stílusokhoz
Minden komponens külön mappában található`

Tippek

Legyen tömör: Ne írj túl sokat, az AI is "elfárad"
Rendszeresen frissítsd: Ne felejtsd el frissíteni a CLAUDE.md-t, amikor a projekt változik
Példák előnyben: A konkrét kódpéldák hatékonyabbak, mint az absztrakt leírások
Fókuszálj a fájdalmas pontokra: A könnyen hibázható helyeket hangsúlyozd

Írd meg jól a CLAUDE.md-t, és tedd az AI-t a jobbkezeddé!