Ispravan način korištenja CLAUDE.md
Ispravan način korištenja CLAUDE.md
CLAUDE.md je posebna datoteka smještena u korijenskom direktoriju projekta, koja služi za informiranje AI asistenata (kao što je Claude) o ključnim informacijama o vašem projektu. Dobro napisana datoteka omogućuje AI-u da bolje razumije i pomogne vam.
Zašto je potreban CLAUDE.md?
Zamislite da vam dolazi novi kolega, koliko vremena vam treba da mu objasnite vaš projekt? CLAUDE.md je taj "priručnik za projekt" koji omogućuje AI-u da brzo počne raditi.
Pet glavnih sadržaja CLAUDE.md
1. Pregled projekta
Jednostavno opišite što projekt radi, koje probleme rješava i kome je namijenjen.
# Pregled projekta Ovo je sustav za upravljanje e-trgovinom, koji se koristi za upravljanje proizvodima, narudžbama i korisnicima.
2. Tehnološki stack
Navedite glavne tehnologije i okvire koji se koriste u projektu.
`# Tehnološki stack
- Frontend: React + TypeScript
- Backend: Node.js + Express
- Baza podataka: PostgreSQL
- Implementacija: Docker + Kubernetes`
3. Struktura datoteka
Objasnite svrhu glavnih direktorija.
# Struktura datoteka /src /components - UI komponente /pages - Stranice /utils - Pomoćne funkcije /api - API pozivi
4. Uobičajene naredbe
Navedite naredbe koje se često koriste u razvoju.
# Uobičajene naredbe npm run dev - Pokretanje razvojnog poslužitelja npm run build - Izrada produkcijske verzije npm run test - Pokretanje testova
5. Pravila
Definirajte pravila kojih bi se AI trebao pridržavati prilikom pisanja koda za vas.
`# Pravila kodiranja
- Koristite funkcijske komponente
- Pridržavajte se ESLint konfiguracije
- Imenovanje komponenti koristite PascalCase
- Imenovanje varijabli koristite camelCase`
Potpuni primjer
`# Naziv projekta: Task Manager
Pregled projekta
Jednostavna aplikacija za upravljanje zadacima, podržava stvaranje, uređivanje, brisanje i kategorizaciju zadataka.
Tehnološki stack
- React 18
- TypeScript
- Tailwind CSS
- Vite
Struktura datoteka
/src /components - UI komponente /hooks - Prilagođene Hooks /types - TypeScript definicije tipova /utils - Pomoćne funkcije
Uobičajene naredbe
- npm run dev: Pokretanje razvojnog poslužitelja
- npm run build: Izrada produkcijske verzije
- npm run lint: Provjera koda
Standardi kodiranja
- Komponente koristite funkcijski način pisanja
- Koristite Tailwind CSS za stilove
- Svaka komponenta se nalazi u zasebnoj mapi`
Savjeti
- Održavajte kratkoću: Nemojte pisati predugo, AI se također može "umoriti"
- Redovito ažurirajte: Zapamtite da ažurirate CLAUDE.md kada se projekt promijeni
- Prioritet primjerima: Davanje konkretnih primjera koda učinkovitije je od apstraktnih opisa
- Usredotočite se na bolne točke: Posebno objasnite područja u kojima je lako pogriješiti
Napišite dobar CLAUDE.md i neka AI postane vaš pouzdan pomoćnik!
