Mënyra e duhur për të hapur CLAUDE.md
Mënyra e duhur për të hapur CLAUDE.md
CLAUDE.md është një skedar special i vendosur në rrënjën e projektit, i cili përdoret për t'i treguar asistentit AI (si Claude) informacionin kryesor rreth projektit tuaj. Shkrimi i mirë i këtij skedari mundëson që AI të kuptojë dhe t'ju ndihmojë më mirë.
Pse nevojitet CLAUDE.md?
Imagjinoni, sa kohë ju duhet që një koleg i ri të kuptojë projektin tuaj? CLAUDE.md është ai "manual i projektit", duke e lejuar AI të fillojë shpejt.
Pesë përmbajtjet kryesore të CLAUDE.md
1. Pasqyrë e projektit
Përshkruani shkurtimisht se çfarë bën ky projekt, çfarë problemi zgjidh dhe kujt i drejtohet.
# Pasqyrë e projektit Ky është një sistem i menaxhimit të prapavijës së tregtisë elektronike, i përdorur për të menaxhuar produktet, porositë dhe përdoruesit.
2. Stack teknologjik
Listoni teknologjitë dhe kornizat kryesore të përdorura nga projekti.
`# Stack teknologjik
- Front-end: React + TypeScript
- Back-end: Node.js + Express
- Databaza: PostgreSQL
- Vendosja: Docker + Kubernetes`
3. Struktura e skedarëve
Shpjegoni funksionin e drejtorive kryesore.
# Struktura e skedarëve /src /components - Komponentët UI /pages - Faqet /utils - Funksionet ndihmëse /api - Thirrjet API
4. Komandat e zakonshme
Listoni komandat e zakonshme të përdorura në zhvillim.
# Komandat e zakonshme npm run dev - Nis serverin e zhvillimit npm run build - Ndërto versionin e prodhimit npm run test - Ekzekuto testet
5. Rregullat
Përcaktoni rregullat që AI duhet të ndjekë kur ju ndihmon të shkruani kod.
`# Rregullat e kodimit
- Përdorni komponentë funksionalë
- Ndiqni konfigurimin ESLint
- Përdorni PascalCase për emërtimin e komponentëve
- Përdorni camelCase për emërtimin e variablave`
Një shembull i plotë
`# Emri i projektit: Task Manager
Pasqyrë e projektit
Një aplikacion i thjeshtë për menaxhimin e detyrave, që mbështet krijimin, redaktimin, fshirjen dhe kategorizimin e detyrave.
Stack teknologjik
- React 18
- TypeScript
- Tailwind CSS
- Vite
Struktura e skedarëve
/src /components - Komponentët UI /hooks - Hooks të personalizuar /types - Përkufizimet e tipave TypeScript /utils - Funksionet ndihmëse
Komandat e zakonshme
- npm run dev: Nis serverin e zhvillimit
- npm run build: Ndërto versionin e prodhimit
- npm run lint: Kontrolli i kodit
Standardet e kodimit
- Komponentët përdorin shkrimin funksional
- Përdorni Tailwind CSS për stilizimin
- Çdo komponent vendoset në një dosje të veçantë`
Këshilla
- Mbajeni të thjeshtë: Mos shkruani shumë gjatë, AI gjithashtu do të "lodhet"
- Përditësoni rregullisht: Mos harroni të përditësoni CLAUDE.md kur projekti ndryshon
- Prioritizoni shembujt: Dhënia e shembujve specifikë të kodit është më efektive sesa përshkrimet abstrakte
- Fokusohuni në pikat e dhimbjes: Përqendrohuni në shpjegimin e zonave ku është e lehtë të bëni gabime
Shkruani mirë CLAUDE.md dhe lëreni AI të bëhet ndihmësi juaj i besueshëm!
