با استفاده از یک یا چند فایل AGENTS.md ، به Gemini در اندروید استودیو دستورالعملهای سفارشی بدهید تا دنبال کنند. فایلهای AGENTS.md در کنار سایر فایلها در کدبیس شما قرار میگیرند، بنابراین بررسی آنها در سیستم کنترل نسخه (VCS) و به اشتراک گذاشتن دستورالعملهای خاص پروژه، قوانین سبک کدنویسی و سایر راهنماییها با کل تیم شما آسان است.
برای شروع، این مراحل را دنبال کنید:
یک فایل
AGENTS.mdدر هر جایی از سیستم فایل پروژه خود ایجاد کنید. Gemini هنگام ارسال یک پرس و جو، دایرکتوری فعلی و تمام دایرکتوریهای والد را برای یافتن فایلهایAGENTS.mdاسکن میکند. برای جزئیات بیشتر، به نحوه عملکرد فایلهایAGENTS.mdمراجعه کنید.دستورالعملهای خود را اضافه کنید. دستورالعملهای خود را با استفاده از Markdown بنویسید. برای خوانایی بیشتر، استفاده از سرتیترها و نقاط بولت را برای قوانین مختلف در نظر بگیرید. به دستورالعملهای نمونه مراجعه کنید .
فایل را ذخیره و در VCS خود کامیت کنید تا با تیم خود به اشتراک بگذارید.
مدیریت فایلهای AGENTS.md به عنوان context
شما میتوانید با استفاده از کشوی Context در پنل چت، فایلهای AGENTS.md را به عنوان context برای یک کوئری خاص اعمال یا حذف کنید. گزینههای AGENTS.md Files شامل تمام فایلهای AGENTS.md در دایرکتوری فعلی و دایرکتوریهای والد آن میشود.
AGENTS.md به عنوان context.دستورالعملهای نمونه
شما میتوانید از فایل AGENTS.md برای ارائه دستورالعمل به عامل استفاده کنید. در ادامه چند مثال آورده شده است، اما دستورالعملهایی که ارائه میدهید باید مختص پروژه شما باشند.
- «فعالیت اصلی
/path/to/MainActivity.ktاست.» - کدی که پیمایش بین صفحات را پشتیبانی میکند
path/to/navigation/UiNavigation.ktاست. - کدی که درخواستهای HTTP را مدیریت میکند در
<path>قرار دارد. - معماری پروژه
- «تمام منطق کسب و کار را در ViewModels قرار دهید.»
- «همیشه توصیههای رسمی معماری، از جمله استفاده از معماری لایهای را دنبال کنید. از جریان داده یکطرفه (UDF)، ViewModelها، مجموعه وضعیت رابط کاربری آگاه از چرخه عمر و سایر توصیهها استفاده کنید.»
- کتابخانههای ترجیحی: "از کتابخانه <نام کتابخانه> برای پیمایش استفاده کنید."
- تعریف نامهای جایگزین برای سرویسهای API رایج یا اصطلاحات داخلی: «سرویس اصلی backend با عنوان 'PhotoSift-API' شناخته میشود.»
- راهنماهای سبک شرکت: «تمام اجزای رابط کاربری جدید باید با Jetpack Compose ساخته شوند. طرحبندیهای مبتنی بر XML را پیشنهاد نکنید.»
فایلهای AGENTS.md خود را ماژولار کنید
شما میتوانید فایلهای بزرگ AGENTS.md را به فایلهای کوچکتری تقسیم کنید که بتوانند در زمینههای مختلف مورد استفاده مجدد قرار گیرند:
مجموعهای از دستورالعملها را جدا کرده و آنها را در یک فایل Markdown دیگر، مانند
style-guidance.md، ذخیره کنید.با استفاده از نماد
@و به دنبال آن مسیر فایلی که میخواهید وارد کنید، به فایلهای Markdown کوچکتر در یک فایلAGENTS.mdارجاع دهید. قالبهای مسیر زیر پشتیبانی میشوند:- مسیرهای نسبی:
-
@./file.md- وارد کردن از همان دایرکتوری -
@../file.md- وارد کردن از دایرکتوری والد -
@./subdirectory/file.md- وارد کردن از یک زیرشاخه
-
- مسیرهای مطلق:
@/absolute/path/to/file.md
- مسیرهای نسبی:
برای مثال، فایل AGENTS.md زیر به دو فایل دستورالعمل دیگر ارجاع میدهد:
# My AGENTS.md
You are an experienced Android app developer.
@./get-started.md
## Coding style
@./shared/style-guidance.md
نحوه عملکرد فایلهای AGENTS.md
Gemini به طور خودکار دایرکتوری فعلی و دایرکتوریهای والد را برای یافتن فایلهای AGENTS.md اسکن میکند و محتوای آنها را به عنوان مقدمه به ابتدای هر اعلان اضافه میکند. اگر هنگام ارسال یک پرسوجو، فایلی باز نباشد، فایل AGENTS.md در ریشه پروژه (در صورت وجود) به طور پیشفرض درج میشود.
تفاوت بین فایلهای AGENTS.md و Rules چیست؟
قوانین همچنین به شما امکان میدهند دستورالعملها و تنظیماتی را تعریف کنید که برای همه اعلانها اعمال میشوند. با این حال، قوانین در فایل IntelliJ /.idea/project.prompts.xml تعریف میشوند، در حالی که فایلهای AGENTS.md در کنار کد منبع شما ذخیره میشوند و مستقل از IDE هستند. اگر یکی از اهداف اصلی شما اشتراکگذاری دستورالعملها با تیمتان است، توصیه میکنیم از فایلهای AGENTS.md استفاده کنید.
تفاوت بین فایلهای AGENTS.md و مهارتها چیست؟
مهارتها نشاندهنده تخصصهای درخواستی هستند که وقتی درخواست شما با شرح مهارتها مطابقت دارد، فراخوانی میشوند، در حالی که محتوای AGENTS.md به ابتدای هر اعلان اضافه میشود. توصیه میکنیم از مهارتها برای وظایف خاص و از فایلهای AGENTS.md برای تأثیرگذاری بر رفتار کلی عامل استفاده کنید. برای کسب اطلاعات بیشتر در مورد مهارتها، به مقدمهای بر مهارتهای اندروید مراجعه کنید.