تخصيص Gemini باستخدام ملفات AGENT.md

قدِّم تعليمات مخصّصة إلى "Gemini في استوديو Android" ليتبعها باستخدام ملف واحد أو أكثر من AGENT.md الملفات. يتم وضع ملفات AGENT.md بجانب الملفات الأخرى في قاعدة الرموز البرمجية، لذا يسهل تسجيلها في نظام التحكّم في الإصدار (VCS) ومشاركة التعليمات الخاصة بالمشروع وقواعد أسلوب الترميز والإرشادات الأخرى مع فريقك بأكمله.

للبدء، اتّبِع الخطوات التالية:

1. أنشِئ ملف AGENT.md في أي مكان في نظام ملفات مشروعك. يفحص Gemini الدليل الحالي وجميع الأدلة الرئيسية بحثًا عن ملفات AGENT.md عند إرسال طلب بحث. لمزيد من التفاصيل، يُرجى الاطّلاع على طريقة عمل ملفات AGENT.md.

2. أضِف تعليماتك. اكتب تعليماتك باستخدام Markdown. لتحسين إمكانية القراءة، ننصحك باستخدام العناوين ونقاط التعداد للقواعد المختلفة. الاطّلاع على تعليمات نموذجية

3. احفظ الملف وأرسِله إلى نظام إدارة الإصدارات (VCS) لمشاركته مع فريقك.

إدارة ملفات AGENT.md كسياق

يمكنك تطبيق ملفات AGENT.md أو إزالتها كسياق لطلب بحث معيّن باستخدام درج السياق في لوحة المحادثة. تتضمّن خيارات AGENT.md الملفات جميع ملفات AGENT.md في الدليل الحالي وأدلته الأصلية.

أمثلة على التعليمات

يمكنك استخدام ملف AGENT.md لتقديم تعليمات إلى البرنامج. في ما يلي بعض الأمثلة، ولكن يجب أن تكون التعليمات التي تقدّمها خاصة بمشروعك.

• "النشاط الرئيسي هو /path/to/MainActivity.kt".
• "رمز التنقّل بين الشاشات هو path/to/navigation/UiNavigation.kt"
• "يمكن العثور على الرمز البرمجي الذي يعالج طلبات HTTP في <path>".
• بنية المشروع
  • "وضع جميع منطق الأنشطة التجارية في ViewModels"
  • اتّبِع دائمًا اقتراحات البنية الرسمية، بما في ذلك استخدام بنية ذات طبقات. استخدِم تدفق البيانات أحادي الاتجاه (UDF) وViewModels ومجموعة حالات واجهة المستخدم المتوافقة مع مراحل النشاط وغيرها من الاقتراحات".
• المكتبات المفضّلة: "استخدِم مكتبة <اسم المكتبة> للتنقّل".
• تحديد أسماء العناصر النائبة لخدمات واجهة برمجة التطبيقات الشائعة أو المصطلحات الداخلية: "يُشار إلى خدمة الخلفية الأساسية باسم PhotoSift-API".
• أدلة الأسلوب في الشركة: "يجب إنشاء جميع عناصر واجهة المستخدم الجديدة باستخدام Jetpack Compose. لا تقترح تخطيطات مستندة إلى XML".

تقسيم ملفات AGENT.md إلى وحدات

يمكنك تقسيم ملفات AGENT.md كبيرة إلى ملفات أصغر يمكن إعادة استخدامها في سياقات مختلفة:

1. فصل مجموعة من التعليمات وحفظها في ملف Markdown آخر، مثل style-guidance.md

2. أشِر إلى ملفات Markdown الأصغر في ملف AGENT.md باستخدام الرمز @ متبوعًا بمسار الملف الذي تريد استيراده. تتوفّر تنسيقات المسارات التالية:

   • المسارات النسبية:
     • @./file.md - الاستيراد من الدليل نفسه
     • @../file.md: الاستيراد من الدليل الرئيسي
     • @./subdirectory/file.md - الاستيراد من دليل فرعي
   • المسارات المطلقة: @/absolute/path/to/file.md

على سبيل المثال، يشير ملف AGENT.md التالي إلى ملفَّي تعليمات آخرَين:

# My AGENT.md

You are an experienced Android app developer.

@./get-started.md

## Coding style

@./shared/style-guidance.md

طريقة عمل ملفات AGENT.md

يفحص Gemini تلقائيًا الدليل الحالي والأدلة الرئيسية بحثًا عن ملفات AGENT.md ويضيف محتواها إلى بداية كل طلب كتمهيد. إذا لم يكن لديك ملف مفتوح عند إرسال طلب بحث، سيتم تضمين الملف AGENT.md في جذر المشروع تلقائيًا (إذا كان هناك ملف).

ما الفرق بين ملفات AGENT.md والقواعد؟

تتيح لك القواعد أيضًا تحديد التعليمات والإعدادات المفضّلة التي تنطبق على جميع الطلبات. ومع ذلك، يتم تحديد القواعد في ملف IntelliJ /.idea/project.prompts.xml، بينما يتم حفظ ملفات AGENT.md بجانب رمز المصدر، وهي متوافقة مع جميع بيئات التطوير المتكاملة. ننصحك باستخدام ملفات AGENT.md إذا كان أحد الأغراض الأساسية هو مشاركة التعليمات مع فريقك.