3.4 KiB
3.4 KiB
🤖 AGENTS.md — دليل الوكلاء لمشروع diyaa.de
أي agent (Claude Code أو غيره) يشتغل على هالمشروع لازم يتبع هالملف. الهدف: تعرف الوضع وتشتغل صح بدون ما تقرأ كل الكود.
1) قبل أي شغل — اقرأ التوثيق
كل الحقيقة موجودة بمجلد docs/:
docs/PROJECT-STATE.md— الوضع الحالي الفعلي. اقرأه أول شي.docs/ARCHITECTURE.md— المعمارية، مخطط الداتابيس، اتفاقيات المجلدات والمكوّنات.docs/STACK.md— الستاك المعتمد (لا تضيف مكتبة خارج المعتمد بدون توثيق السبب).docs/TODO.md— المهام المفتوحة.docs/CHECKLIST.md— نظرة شاملة على المتبقّي.docs/IDEAS.md— أفكار مستقبلية.
2) لما يُسأل "شو عنا شي نعملو؟"
- افتح
docs/TODO.md. - اقترح أول مهمة
🔵 مفتوحةوغير محجوبة من أعلى القائمة. - لا تقترح مهمة حالتها
⛔ محجوبةقبل ما تخلص المهمة يلي بتحجبها.
3) أثناء التنفيذ
- غيّر حالة المهمة بـ
TODO.mdلـ🟡 قيد التنفيذ. - التزم باتفاقيات
ARCHITECTURE.md:- كل شي مكوّنات قابلة لإعادة الاستخدام.
- Tailwind + shadcn/ui فقط للتنسيق (بدون CSS خام جديد).
- كل المكتبات محليّة — بدون CDN وقت التشغيل.
- Server Components افتراضياً؛
"use client"عند الحاجة فقط. - دعم ar/en و RTL/LTR بكل مكوّن عام.
- كل مدخلات المستخدم تتحقّق بـ Zod.
4) بعد إنجاز المهمة (إلزامي)
docs/TODO.md: انقل المهمة من "🔵 مفتوحة" لـ "✅ منجزة (Ready)" مع التاريخ ورقم المهمة، وحرّر حالات المهام يلي انفتحت (من ⛔ لـ 🔵).docs/PROJECT-STATE.md: حدّث جداول "الموجود/الناقص"، وأضف سطر بالـ Changelog إذا كانت خطوة كبيرة.docs/CHECKLIST.md: علّم البنود المنجزة[x].- إذا انبثقت فكرة جديدة مو مجدولة → ضيفها لـ
docs/IDEAS.md.
⚠️ القاعدة الذهبية: لا تخلّي الكود يسبق التوثيق. إذا غيّرت كود وما وثّقت — الشغل مو خالص.
5) أوامر مفيدة
make start # تشغيل عبر Docker
make logs # اللوقات
make stop
npm run dev # تطوير محلي
npm run check # lint + typecheck + build
(بعد إضافة الداتابيس رح ينضاف: make migrate, make studio, make seed — شوف ARCHITECTURE.md §9.)
6) حدود مهمة
- لا ترفع أسرار للـ git (SMTP, DATABASE_URL, AUTH secret). كلها بـ
.envفقط. - لا تضيف dependency خارج
STACK.mdبدون توثيق السبب بـPROJECT-STATE.md. - لا تكسر وضع coming-soon / الصيانة الموجود.
- حافظ على بنية النشر (Docker + Traefik) شغّالة.