Home / Glossary / CLAUDE.md

Definition

CLAUDE.md

Ang CLAUDE.md ay isang markdown configuration file na inilalagay sa root ng iyong proyekto na nagbibigay sa Claude Code ng mga persistent, partikular sa proyektong tagubilin. Sinasabi nito sa agent ang tungkol sa iyong mga coding convention, arkitektura, mga karaniwang command, at mga panuntunan — gumaganap bilang isang anyo ng pangmatagalang memorya na naaangkop sa bawat sesyon sa loob ng proyektong iyon.

Paano gumagana ang CLAUDE.md

Kapag nagsimula ang Claude Code ng sesyon, awtomatiko itong nagbabasa ng CLAUDE.md file sa root ng iyong proyekto (at anumang CLAUDE.md file sa mga parent directory o subdirectory). Ang mga nilalaman ay nagiging bahagi ng system context ng agent, kaya sinusunod nito ang iyong mga tagubilin nang hindi na kailangang ipaalala sa bawat sesyon. Ginagawa nitong consistent ang gawi ng agent sa mga convention ng iyong koponan.

Ano ang isasama sa CLAUDE.md

  • +Pangkalahatang-ideya ng arkitektura ng proyekto at mga pangunahing lokasyon ng file
  • +Mga coding convention (pagbibigay ng pangalan, formatting, mga pattern na gagamitin o iiwasan)
  • +Mga karaniwang command para sa pagsubok, pagtatayo, at pag-deploy
  • +Mga panuntunan tulad ng "palaging sumulat ng test para sa mga bagong function" o "huwag kailanman direktang baguhin ang auth module"
  • +Mga detalye ng technology stack na dapat malaman ng agent
markdown
# CLAUDE.md

## Proyekto
Next.js 14 app na may App Router, TypeScript, Tailwind CSS.

## Mga Command
- `npm run dev` — simulan ang dev server
- `npm test` — patakbuhin ang mga Jest test
- `npm run lint` — pagsuri ng ESLint

## Mga Convention
- Gumamit ng mga server component bilang default
- Ang mga client component ay napupunta sa `components/client/`
- Ang lahat ng API route ay dapat mag-validate ng input gamit ang Zod
- Sumulat ng mga test para sa bawat bagong utility function

## HUWAG
- Baguhin ang mga file sa `lib/core/` nang walang malinaw na pag-apruba
- Gumamit ng uri na `any` sa TypeScript
- Magdagdag ng mga bagong dependency nang walang katwiran

Panatilihing maikli ang CLAUDE.md. Binabasa ito ng agent sa bawat sesyon, kaya isama lamang ang impormasyong may kaugnayan sa maraming gawain. Ilipat ang mga detalye na partikular sa gawain sa iyong mga prompt sa halip.

Saan ko dapat ilagay ang CLAUDE.md file?+
Ilagay ito sa root ng iyong project directory. Sinusuportahan din ng Claude Code ang mga CLAUDE.md file sa mga subdirectory para sa mga tagubilin na partikular sa module, at sa mga parent directory para sa mga panuntunan sa buong organisasyon. Lahat ng naaangkop na file ay pinagsama-sama.
Gumagana ba ang CLAUDE.md sa ibang mga AI tool?+
Ang CLAUDE.md ay partikular sa Claude Code. Gayunpaman, ilang ibang tool ang nagpatibay ng mga katulad na konsepto. Gumagamit ang Cursor ng .cursorrules, at ang ibang mga agent ay maaaring magbasa ng mga custom na config file. Ang konsepto ng mga tagubilin ng AI sa antas ng proyekto ay nagiging isang karaniwang pattern.
Gaano katagal dapat ang CLAUDE.md?+
Panatilihin itong wala pang 500 linya. Tumutok sa mga pinakamahalagang convention at panuntunan. Maaaring palaging magbasa ang agent ng mga indibidwal na file para sa mga detalye — ang CLAUDE.md ay dapat magbigay ng mataas na antas na context na naaangkop sa lahat ng gawain.

Related terms

Agentic CodingClaude CodePrompt Engineering para sa Code

Master Claude Code in days, not months

37 hands-on lessons from beginner to CI/CD automation. Module 1 is free.

START FREE →
← ALL TERMS