وثائق

اكتب ملف AGENTS.md لوكلاءك ووكلاء Coroid

ملف توجيهي واحد لمساعدي المطورين ووكلاء Coroid. ما يستخدمه الطرفان، وما تقوم به Coroid ذاتها، وكيفية الحفاظ على معيار جودة موحد.

مساعدو المطورين، مثل Claude Code وCodex وCursor، ووكلاء Coroid يقرؤون نفس AGENTS.md. معظم هذا المحتوى مشترك بينهم: الأوامر والاتفاقيات والحدود. الجزء الذي لا يُستخدم بشكل مشترك هو سير عمل Git، لأن Coroid هي التي تنشئ الفرع والالتزام وطلب السحب بنفسها.

ما يقرؤه وكلاء Coroid

قبل كل مهمة، يقرأ وكلاء Coroid ملفات الذاكرة الموجودة في جذر المستودع: AGENTS.md، CLAUDE.md، GEMINI.md وقواعد Cursor في .cursor/rules. وهم يتبعون @ عمليات الاستيراد، وتُدرج التعليمات المتطابقة مرة واحدة فقط. اختر المصادر التي يتلقاها الوكلاء تحت إعدادات ← معرفة ← سياق. انظر إلى سياق المشروع.

تقرأ المهمة الملفات من نسختها الخاصة، لذا أي تغيير في AGENTS.md ينطبق على المهام التي تبدأ بعد وصولها إلى الفرع الأساسي.

ما يُستخدم بشكل مشترك

اكتب هذه التعليمات مرة واحدة، لكل وكيل:

  • الأوامر: تثبيت، بناء، اختبار، وأضيق اختبار مفيد، مثل حزمة واحدة أو ملف واحد. تحقق من صحتها من نسخة نظيفة، وحدد اسم الدليل لتشغيلها والخدمات التي تحتاجها الاختبارات.
  • الاتفاقيات التي لا تظهر في الكود: التسمية، معالجة الأخطاء، كيفية ترجمة النصوص، والأنماط المحظورة.
  • الحدود: الوحدات المتجمدة، المسارات التي يملكها فريق معين، الاعتماديات التي لا يجب إضافتها، والملفات التي لا يجب تعديلها يدويًا.

اجعله موجزًا. كل سطر يُقرأ في كل مهمة، بواسطة كل وكيل. ربط بوثيقة أطول بدلاً من لصقها، وتجاهل ما يعرضه الكود بالفعل.

ما تقوم به Coroid ذاتها

تعدل وكلاء Coroid الملفات في بيئة معزولة. وتتولى Coroid باقي الخطوات:

خطوةفي Coroid
فرعتنشئ Coroid فرعًا لكل مهمة: feature/coroid-<id>-<title>، أو bugfix/، refactor/، test/ أو docs/ حسب نوع العمل. تستخدم مسارات الخطة coroid/factory/…
التزامتكتب Coroid رسالة الالتزام وتضيف ملاحق المنشأ مثل Coroid-Task. عندما يكون حسابك المتصل هو المؤلف، تضيف Co-authored-by: Coroid <ai@coroid.ai>
دفعتقوم Coroid بدفع الفرع. ترفض البيئة المعزولة git push، git pull، git fetch و git clone، ولا تحتفظ ببيانات اعتماد لمزودك.
طلب سحبتفتحه Coroid، ويحمل عنوان المهمة، مع وصف يربط المهمة ومعايير القبول ونتائج الاختبار والمراجعة.

تعليمات مثل "اعمل على فرع ws/ فرع"، "افتح pull request بـ gh pr create" أو "أنهِ كل التزام بسطر مؤلف مشترك" لا تنطبق داخل Coroid. فالملفات التي يغيرها الوكيل فقط هي التي تغادر البيئة المعزولة، لذا يتم التخلص من الفرع أو الالتزام الذي ينشئه هناك. تخبر Coroid وكلاءها بذلك قبل ملفات التوجيه: فيتجاهلون تلك الخطوات ويتبعون باقي التعليمات.

لا يتم إرسال أي شيء إلى فرعك الأساسي: انظر إلى إعدادات المستودع والفرع.

حدد الأجزاء التي تنطبق في كل مكان

تتجاهل وكلاء Coroid بالفعل سير عمل Git الخاص بك. ذكر ذلك في الملف يساعد كل قارئ، بما في ذلك الأشخاص، ويحتفظ بخطوة خاصة بـ Coroid، مثل فحص يجب تشغيله قبل الانتهاء، في مكان واحد. ضع قسمًا موجزًا في الأعلى:

## Working in Coroid

When you run inside Coroid, Coroid creates the branch, commits, pushes and
opens the pull request. Change files only, and skip "Git workflow" below.
Before you finish, run `npm run validate`.

ثم حدد سير العمل المحلي كما هو:

## Git workflow (local agents)

- Branch: `ws/<nn>-<name>` from `main`, in your own worktree.
- Commit messages end with your assistant's co-author line.
- Run `npm run check:local`, then open the pull request with `gh pr create`.

يحتفظ مساعدو المطورين بسير عملهم، ولا يحتاج أحد إلى تخمين أي الخطوات تعود لمن.

الفحوصات التي يجب أن تجتازها كل عمليات pull request

الفحص المكتوب فقط في AGENTS.md يتم تشغيله عندما يقرر الوكيل تشغيله. تتجاهل التزامات Coroid أيضًا خطافات Git في مستودعك، مثل Husky أو Pre-commit. الفحص الذي يجب أن يُطبق على كل تغيير يجب أن يكون موجودًا في ضبط الجودة كـ أمر مستودع فحص:

  • تشغله Coroid على التغييرات التي يجریها وكلاؤها.
  • عند تفعيل فحوصات pull request، يتم تشغيلها أيضًا على طلبات السحب التي يفتحها فريقك، بما في ذلك تلك التي تم إنشاؤها باستخدام Claude Code أو Codex أو Cursor.

وبذلك تلتقي طريقتا العمل على نفس المعيار. انظر إلى سياسات الجودة والحواجز.

بالنسبة لقواعد مكافحة الكود غير المرغوب فيه، يمكن لمساعد المطور أن يطلبها من Coroid عبر MCP. anti_slop_rules تُرجع مقتطفًا يوضح قواعد المشروع لـ AGENTS.md: انظر إلى قواعد مكافحة الكود غير المرغوب فيه من محررك.

نظام تكامل مستمر يعمل فقط لبعض الفروع

إذا كان نظام التكامل المستمر أو حماية الفروع يعمل فقط لبعض أسماء الفروع، أضف إعدادات Coroid:

feature/coroid-*
bugfix/coroid-*
refactor/coroid-*
test/coroid-*
docs/coroid-*
coroid/factory/**

وإلا، ستُفتح طلبات سحب Coroid دون الفحوصات التي يعتمد عليها فريقك.

ملف واحد لكل أداة

احتفظ بالتعليمات مرة واحدة، في AGENTS.md:

  • Codex و Cursor اقرأ AGENTS.md.
  • Claude Code يقرأ CLAUDE.md. اجعله سطرًا واحدًا، بالإضافة إلى أي شيء يحتاجه Claude Code فقط. @AGENTS.md سطرًا واحدًا، بالإضافة إلى أي شيء يحتاج إليه Claude Code وحده.
  • Cursor يقرأ قواعده أيضًا في .cursor/rules. Coroid يقرأها بينما يطبقها Cursor: انظر إلى سياق المشروع.

Coroid يقرأ CLAUDE.md باستخدام أداة الاستيراد الخاصة به ويضمّنها AGENTS.md مرة واحدة.

تحقق مما يقرأه Coroid

تحت إعدادات ← معرفة ← سياق، مصادر المستودع يعرض كل ملف مع عدد التوكنات المقدّر وخيار تبديل. تحرير يفتح ملفًا هناك. الحفظ يفتح طلب سحب في pull request على مستودع متصل، بحيث تمر التغييرات عبر نفس عملية المراجعة مثل أي طلب آخر.