Pravilen način uporabe CLAUDE.md
Pravilen način uporabe CLAUDE.md
CLAUDE.md je posebna datoteka, ki se nahaja v korenski mapi projekta in je namenjena posredovanju ključnih informacij o vašem projektu pomočnikom AI (kot je Claude). Dobro napisana datoteka omogoča AI, da bolje razume in vam pomaga.
Zakaj potrebujemo CLAUDE.md?
Predstavljajte si, da imate novega sodelavca. Koliko časa potrebujete, da razume vaš projekt? CLAUDE.md je tisti "priročnik za projekt", ki AI omogoča hiter začetek.
Pet ključnih vsebin CLAUDE.md
1. Pregled projekta
Preprosto opišite, kaj projekt počne, katere probleme rešuje in komu je namenjen.
# Pregled projekta To je sistem za upravljanje e-trgovine, ki se uporablja za upravljanje izdelkov, naročil in uporabnikov.
2. Tehnološki sklad
Navedite glavne tehnologije in ogrodja, ki se uporabljajo v projektu.
`# Tehnološki sklad
- Frontend: React + TypeScript
- Backend: Node.js + Express
- Baza podatkov: PostgreSQL
- Namestitev: Docker + Kubernetes`
3. Struktura datotek
Opišite vlogo glavnih map.
# Struktura datotek /src /components - UI komponente /pages - Strani /utils - Pomožne funkcije /api - API klici
4. Pogosti ukazi
Navedite pogoste ukaze, ki se uporabljajo pri razvoju.
# Pogosti ukazi npm run dev - Zažene razvojni strežnik npm run build - Zgradi produkcijsko različico npm run test - Izvede teste
5. Pravila
Definirajte pravila, ki jih mora AI upoštevati pri pisanju kode za vas.
`# Pravila kodiranja
- Uporabljajte funkcijske komponente
- Upoštevajte konfiguracijo ESLint
- Imena komponent uporabljajte PascalCase
- Imena spremenljivk uporabljajte camelCase`
Celoten primer
`# Ime projekta: Task Manager
Pregled projekta
Preprosta aplikacija za upravljanje nalog, ki podpira ustvarjanje, urejanje, brisanje in kategorizacijo nalog.
Tehnološki sklad
- React 18
- TypeScript
- Tailwind CSS
- Vite
Struktura datotek
/src /components - UI komponente /hooks - Lastni Hooks /types - Definicije tipov TypeScript /utils - Pomožne funkcije
Pogosti ukazi
- npm run dev: Zažene razvojni strežnik
- npm run build: Zgradi produkcijsko različico
- npm run lint: Preveri kodo
Standardi kodiranja
- Komponente uporabljajo funkcijski pristop
- Za sloge uporabljajte Tailwind CSS
- Vsaka komponenta je v ločeni mapi`
Nasveti
- Bodite jedrnati: Ne pišite predolgo, AI se bo tudi "utrudil"
- Redno posodabljajte: Ne pozabite posodobiti CLAUDE.md, ko se projekt spremeni
- Dajte prednost primerom: Konkretni primeri kode so učinkovitejši od abstraktnih opisov
- Osredotočite se na boleče točke: Poudarite področja, kjer je verjetnost napak velika
Napišite dober CLAUDE.md in AI bo postal vaš dragocen pomočnik!
