Właściwe użycie CLAUDE.md

CLAUDE.md to specjalny plik umieszczony w katalogu głównym projektu, który informuje asystenta AI (np. Claude) o kluczowych informacjach dotyczących Twojego projektu. Dobrze napisany plik pozwala AI lepiej zrozumieć i pomóc Ci.

Dlaczego potrzebujesz CLAUDE.md?

Wyobraź sobie, że masz nowego kolegę w pracy. Ile czasu zajmie Ci wytłumaczenie mu, o co chodzi w Twoim projekcie? CLAUDE.md to taki "podręcznik projektu", który pozwala AI szybko zacząć.

Pięć głównych elementów CLAUDE.md

1. Przegląd projektu

Krótko opisz, czym zajmuje się projekt, jakie problemy rozwiązuje i do jakich użytkowników jest skierowany.

# 项目概览这是一个电商后台管理系统，用于管理商品、订单和用户。

# Przegląd projektu
To system zarządzania zapleczem e-commerce, służący do zarządzania produktami, zamówieniami i użytkownikami.

2. Stos technologiczny

Wymień główne technologie i frameworki używane w projekcie.

`# 技术栈

前端：React + TypeScript
后端：Node.js + Express
数据库：PostgreSQL
部署：Docker + Kubernetes`

# Stos technologiczny
- Frontend: React + TypeScript
- Backend: Node.js + Express
- Baza danych: PostgreSQL
- Wdrożenie: Docker + Kubernetes

3. Struktura plików

Wyjaśnij rolę głównych katalogów.

# 文件结构 /src /components - UI组件 /pages - 页面 /utils - 工具函数 /api - API调用

# Struktura plików
/src
  /components - Komponenty UI
  /pages - Strony
  /utils - Funkcje narzędziowe
  /api - Wywołania API

4. Często używane polecenia

Wymień polecenia często używane podczas developmentu.

# 常用命令 npm run dev - 启动开发服务器 npm run build - 构建生产版本 npm run test - 运行测试

# Często używane polecenia
npm run dev - Uruchomienie serwera deweloperskiego
npm run build - Budowanie wersji produkcyjnej
npm run test - Uruchomienie testów

5. Reguły

Zdefiniuj reguły, których AI powinno przestrzegać podczas pisania kodu.

`# 编码规则

使用函数式组件
遵循 ESLint 配置
组件命名使用 PascalCase
变量命名使用 camelCase`

# Zasady kodowania
- Używaj komponentów funkcyjnych
- Przestrzegaj konfiguracji ESLint
- Używaj PascalCase do nazywania komponentów
- Używaj camelCase do nazywania zmiennych

Kompletny przykład

`# 项目名称：Task Manager

项目概览

一个简单的任务管理应用，支持任务的创建、编辑、删除和分类。

技术栈

React 18
TypeScript
Tailwind CSS
Vite

文件结构

/src /components - UI组件 /hooks - 自定义Hooks /types - TypeScript类型定义 /utils - 工具函数

常用命令

npm run dev: 启动开发服务器
npm run build: 构建生产版本
npm run lint: 代码检查

编码规范

组件使用函数式写法
使用 Tailwind CSS 进行样式
每个组件放在单独的文件夹中`

# Nazwa projektu: Task Manager

## Przegląd projektu
Prosta aplikacja do zarządzania zadaniami, obsługująca tworzenie, edycję, usuwanie i kategoryzację zadań.

## Stos technologiczny
- React 18
- TypeScript
- Tailwind CSS
- Vite

## Struktura plików
/src
  /components - Komponenty UI
  /hooks - Własne Hooki
  /types - Definicje typów TypeScript
  /utils - Funkcje narzędziowe

## Często używane polecenia
- npm run dev: Uruchomienie serwera deweloperskiego
- npm run build: Budowanie wersji produkcyjnej
- npm run lint: Sprawdzanie kodu

## Standardy kodowania
- Komponenty pisane funkcyjnie
- Używanie Tailwind CSS do stylów
- Każdy komponent umieszczony w osobnym folderze

Wskazówki

Zachowaj zwięzłość: nie pisz zbyt długo, AI też się "zmęczy"
Regularnie aktualizuj: pamiętaj o aktualizacji CLAUDE.md, gdy projekt się zmienia
Przykłady przede wszystkim: konkretne przykłady kodu są bardziej efektywne niż abstrakcyjne opisy
Skoncentruj się na problemach: zwróć szczególną uwagę na miejsca, w których łatwo o błędy

Napisz dobrze CLAUDE.md i spraw, aby AI stało się Twoim niezastąpionym pomocnikiem!