إنتقل إلى المحتوى الرئيسي

قوالب بدء CLAUDE.md

جميع المستويات

CLAUDE.md هو أعلى الأشياء قيمةً يمكنك تقديمها إلى Claude Code: تعليمات دائمة يقرأها في كل جلسة. ضع أحد هذه القوالب في جذر المستودع (أو شغّل /init لإنشاء نقطة انطلاق)، ثم هذّبه ليناسبك. استخدم زر النسخ في كل كتلة.

:::tip اجعله قصيراً وصادقاً الـ CLAUDE.md الطويل أو الطموح أو القديم يضرّ — إذ يتبعه Claude حرفياً. صِف كيف يعمل المشروع فعلياً، وقلّمه بلا رحمة. التفاصيل في صفحة CLAUDE.md. :::

قالب بدء شامل

# Project: <name>

## What this is
<One or two sentences: what the project does and who uses it.>

## Tech stack
- Language/runtime: <e.g. TypeScript, Node 20>
- Framework: <e.g. Next.js 14 App Router>
- Key libraries: <e.g. Prisma, tRPC, Tailwind>

## How to run
- Install: `<cmd>`
- Dev server: `<cmd>`
- Tests: `<cmd>`
- Lint/format: `<cmd>`

## Conventions
- <e.g. Use functional components; no class components.>
- <e.g. Co-locate tests as *.test.ts next to source.>
- <e.g. Conventional Commits for messages.>

## Guardrails
- Run the tests before saying a task is done.
- Don't edit files under `/generated` or `/vendor`.
- Never commit secrets or .env files.

## Good to know
- <Gotchas, non-obvious decisions, links to deeper docs.>

تطبيق ويب بـ Node / TypeScript

# Project: <name> (Next.js + TypeScript)

## How to run
- Dev: `npm run dev`
- Build: `npm run build`
- Test: `npm test`
- Lint: `npm run lint` (must pass before commit)

## Conventions
- TypeScript strict; no `any` without a comment justifying it.
- Components in `src/components`, one folder per component.
- Data fetching via tRPC; never call the DB from a client component.
- Styling: Tailwind utility classes; no inline styles.

## Guardrails
- After any change, run `npm run lint && npm test`.
- Keep files under ~300 lines; split when larger.
- Do not modify `prisma/migrations` by hand.

خدمة Python

# Project: <name> (FastAPI)

## How to run
- Install: `uv sync` (or `pip install -e .`)
- Dev: `uvicorn app.main:app --reload`
- Test: `pytest`
- Lint/format: `ruff check . && ruff format .`

## Conventions
- Type hints everywhere; prefer `pathlib` over `os.path`.
- Pydantic models for all request/response bodies.
- f-strings, not %-formatting.

## Guardrails
- Run `pytest` and `ruff check` before completing a task.
- Fail fast with descriptive errors; no silent excepts.

نصائح تنطبق عليها جميعاً

  • رتّبه على طبقات. ملف CLAUDE.md في جذر المستودع للمشروع بأكمله؛ وملفات CLAUDE.md متداخلة في المجلدات الفرعية للقواعد الخاصة بكل منطقة.
  • استخدم @imports لجلب المستندات الموجودة بدلاً من تكرارها (راجع مرجع CLAUDE.md).
  • راجعه شهرياً. التعليمات القديمة أسوأ من عدم وجودها.

ذات صلة