الوصف
AGENTS.md هو تنسيق بسيط ومفتوح لإرشاد وكلاء البرمجة، ويستخدمه أكثر من 60 ألف مشروع مفتوح المصدر. اعتبره كملف README للوكلاء. ملفات README.md التقليدية مصممة للمساهمين البشريين، حيث تقدم بدايات سريعة، ووصف للمشروع، وإرشادات للمساهمة. يكمل AGENTS.md هذا من خلال توفير السياق الإضافي، أحيانًا بالتفصيل، الذي يحتاجه وكلاء البرمجة، مثل خطوات البناء، والاختبارات، والاتفاقيات التي قد تعيق README أو لا تكون ذات صلة بالمساهمين البشريين.
يفصل AGENTS.md عن README.md عدة أغراض. يوفر للوكلاء مكانًا واضحًا وقابلًا للتنبؤ للتعليمات، ويحافظ على اختصار READMEs وتركيزها على المساهمين البشريين، ويقدم إرشادات دقيقة تركز على الوكلاء تكمل README الحالية والوثائق. بدلاً من تقديم ملف ملكي آخر، يعتمد AGENTS.md اسمًا وتنسيقًا يمكن استخدامه من قبل أي شخص. إذا كنت تبني أو تستخدم وكلاء برمجة وتجد أن هذا التنسيق مفيد، يُشجعك على اعتماده.
ملف AGENTS.md واحد متوافق عبر العديد من الوكلاء، مما يجعله أداة متعددة الاستخدامات للمطورين. يمكن أن تعمل تعريفات الوكلاء التي تنشئها بسلاسة مع نظام بيئي متزايد من وكلاء وأدوات البرمجة الذكية، بما في ذلك openai/codex، apache/airflow، temporalio/sdk-java، وPlutoLang/Pluto. لاستخدام AGENTS.md بفعالية، يجب عليك إضافة الملف إلى مشروعك وتغطية ما يهم من خلال تضمين أقسام تساعد الوكيل على العمل بفعالية. تشمل الخيارات الشائعة لهذه الأقسام نظرة عامة على المشروع، وأوامر البناء والاختبار، وإرشادات نمط الكود، وتعليمات الاختبار، واعتبارات الأمان.
ظهر AGENTS.md من جهود تعاونية عبر نظام تطوير البرمجيات الذكية، بما في ذلك مساهمات من OpenAI Codex، Amp، Jules من Google، Cursor، وFactory. يتم الآن إدارة التنسيق من قبل مؤسسة Agentic AI تحت مؤسسة Linux، مع التزام بالحفاظ عليه وتطويره كتنسيق مفتوح يفيد مجتمع المطورين بأكمله، بغض النظر عن وكيل البرمجة المستخدم.
الميزات الأساسية لـ AGENTS.md
تنسيق مفتوح
متوافق مع عدة وكلاء
سياق مفصل لوكلاء البرمجة
يدعم ملفات AGENTS.md المتداخلة
إرشادات للتعليمات الخاصة بالمشروع
تطوير مدفوع من المجتمع
مدار من قبل مؤسسة Agentic AI
يسهل التعاون عبر المشاريع
كيفية استخدام AGENTS.md؟
أضف AGENTS.md: قم بتضمين ملف AGENTS.md في مشروعك.
غط ما يهم: أضف أقسامًا تساعد الوكيل على العمل بفعالية مع مشروعك.
أضف تعليمات إضافية: قدم إرشادات إضافية حسب الحاجة.
استخدم الملفات المتداخلة: بالنسبة للمشاريع الكبيرة، نفذ ملفات AGENTS.md المتداخلة للمشاريع الفرعية.
حالات استخدام AGENTS.md
- توثيق المشروع
- التعاون في المصادر المفتوحة
- تكوين الوكيل
- تعليمات الاختبار
- خطوات البناء
