Teisingas CLAUDE.md naudojimas

CLAUDE.md yra specialus failas, esantis projekto šakniniame kataloge, skirtas informuoti AI asistentą (pvz., Claude) apie pagrindinę informaciją apie jūsų projektą. Parašius šį failą, AI galės geriau suprasti ir padėti jums.

Kodėl reikalingas CLAUDE.md?

Įsivaizduokite, kad turite naują kolegą. Kiek laiko jums prireiks, kad jis suprastų jūsų projektą? CLAUDE.md yra tas „projekto vadovas“, leidžiantis AI greitai pradėti darbą.

Penki pagrindiniai CLAUDE.md turinio elementai

1. Projekto apžvalga

Trumpai aprašykite, ką projektas daro, kokią problemą sprendžia ir kam jis skirtas.

# Projekto apžvalga Tai yra el. prekybos administravimo sistema, skirta valdyti produktus, užsakymus ir vartotojus.

2. Technologijų rinkinys

Išvardykite pagrindines projekte naudojamas technologijas ir sistemas.

`# Technologijų rinkinys

Priekinė dalis: React + TypeScript
Galinė dalis: Node.js + Express
Duomenų bazė: PostgreSQL
Diegimas: Docker + Kubernetes`

3. Failų struktūra

Paaiškinkite pagrindinių katalogų paskirtį.

# Failų struktūra /src /components - UI komponentai /pages - Puslapiai /utils - Pagalbinės funkcijos /api - API iškvietimai

4. Dažniausiai naudojamos komandos

Išvardykite dažniausiai naudojamas komandas kūrimo metu.

# Dažniausiai naudojamos komandos npm run dev - Paleisti kūrimo serverį npm run build - Sukurti gamybinę versiją npm run test - Vykdyti testus

5. Taisyklės

Apibrėžkite taisykles, kurių AI turėtų laikytis, kai padeda jums rašyti kodą.

`# Kodavimo taisyklės

Naudoti funkcinius komponentus
Laikytis ESLint konfigūracijos
Komponentų pavadinimai turi būti PascalCase
Kintamųjų pavadinimai turi būti camelCase`

Pilnas pavyzdys

`# Projekto pavadinimas: Užduočių tvarkyklė

Projekto apžvalga

Paprasta užduočių valdymo programa, palaikanti užduočių kūrimą, redagavimą, trynimą ir klasifikavimą.

Technologijų rinkinys

React 18
TypeScript
Tailwind CSS
Vite

Failų struktūra

/src /components - UI komponentai /hooks - Individualūs Hooks /types - TypeScript tipų apibrėžimai /utils - Pagalbinės funkcijos

Dažniausiai naudojamos komandos

npm run dev: Paleisti kūrimo serverį
npm run build: Sukurti gamybinę versiją
npm run lint: Kodo patikra

Kodavimo standartai

Komponentai rašomi naudojant funkcinį stilių
Naudojamas Tailwind CSS stiliams
Kiekvienas komponentas patalpinamas atskirame aplanke`

Patarimai

Būkite glaustas: nerašykite per ilgai, AI taip pat gali „pavargti“
Reguliariai atnaujinkite: nepamirškite atnaujinti CLAUDE.md, kai projektas keičiasi
Pirmenybė pavyzdžiams: konkretūs kodo pavyzdžiai yra efektyvesni nei abstraktūs aprašymai
Sutelkite dėmesį į skaudulius: pabrėžkite vietas, kuriose lengva padaryti klaidų

Parašykite gerą CLAUDE.md ir paverskite AI savo patikimu pagalbininku!