المساهمة
إعداد التطوير
git clone https://github.com/litlfred/folio-assistant.git
cd folio-assistant
bun install
bun test # اختبارات الوحدة
bun run cat lint # eslint
bun run cat test:e2e # e2e (test:e2e)
خطة العمل باستخدام beans
يستخدم هذا المشروع beans بوصفه الآلية الوحيدة
لقوائم المهام وخطة العمل (راجع AGENTS.md). لا تُنشئ مخزن مهام منفصلًا.
scripts/install-beans.sh
beans list
beans create "<العنوان>"
beans <id> --status in-progress # احجزه قبل أن تبدأ العمل
beans ≠ sidecars: لا تستخدم beans create مطلقًا لطوابير المهام المجمعة المولدة آليًا (QA وwitness وwatcher) — فتلك تظل كملفات JSON مجمعة.
إرشادات الوكلاء
يُعدّ AGENTS.md هو المصدر الموثوق العام للوكلاء (تتم قراءته تلقائيًا بواسطة Claude Code
وGemini CLI وAntigravity وCursor وCopilot). أما CLAUDE.md وGEMINI.md فهما مجرد ملفات
نائبة مقتضبة تشير إليه. احرص على تحديث AGENTS.md بدلاً من الملفات المخصصة لأداة بعينها
عند تغيير إرشادات الوكلاء.
التوثيق
- توجد المستندات النثرية في
docs/(موقع Jekyll هذا). مرجع مخططات المهارات مُولَّد آليًا — إياك وتعديل
docs/reference/skills/*.mdيدويًا. عدّل مخططات JSON Schemas الموجودة تحتschemas/skills/<skill>/ثم أعد التوليد:bun run scripts/gen-schema-docs.tsتعليمات المهارات (
docs/reference/skill-instructions/*.md) مُولَّدة آليًا أيضًا — إياك وتعديلها يدويًا. عدّل نصوص المهارات تحتskills/authoring/content-lifecycle/*.mdأوsrc/skills/*.mdثم أعد التوليد:bun run scripts/gen-skill-docs.ts- يُولَّد مرجع واجهة برمجة تطبيقات TypeScript (
/api/) بواسطة TypeDoc في CI. - يتم بناء الموقع ونشره على صفحات GitHub (GitHub Pages) بواسطة
.github/workflows/docs-site.ymlعند كل دفع (push) إلىmainيمس التوثيق أو المخططات أو الشفرة المصدرية.
المعاينة محليًا:
cd docs
bundle install
bundle exec jekyll serve
شحن التغيير
تحقق ← تأكد من قابلية الدمج ← ادفع (push) ← (فقط إذا طُلب منك) افتح طلب سحب (PR). راجع
skills/sdlc/sdlc-core/prepare-merge.md. حافظ على فصل الصياغة الرسمية لإطار العمل
عن المحتوى — فالمحتوى ينتمي إلى مستودعه الخاص، وأي محتوى
في هذه المستندات هو توضيحي فقط.