برای GitHub Copilot یک فایل .github/copilot-instructions.md بنویس که دستورهای ساخت، تست و قاعدههای مخزن را بدهد؛ برای قاعدههای مخصوص یک بخش از کد هم فایلهای .instructions.md با applyTo بساز. مستندات رسمی توصیه میکند فایل کوتاه، غیرمخصوص یک کار و آزمودهشده باشد.
بر پایهٔ مستندات رسمی GitHub در ۲۶ آبان ۱۴۰۵. پشتیبانی هر نوع فایل بسته به محیط (GitHub.com، VS Code، CLI و …) فرق میکند؛ جدول مستندات را برای محیط خودت ببین.
سه نوع فایل
- دستور کل مخزن:
.github/copilot-instructions.mdبه صورت Markdown. اگر پوشهٔ.githubنیست بساز. - دستور مخصوص مسیر: فایلهایی با نام
NAME.instructions.mdدر.github/instructionsیا زیر آن. در بالای فایل با کلیدapplyToالگوی مسیر را مینویسی، مثلاًapplyTo: "**/*.ts,**/*.tsx". کلید اختیاریexcludeAgentمقدارcode-reviewیاcloud-agentمیگیرد تا یکی از خوانندهها آن را نخواند. - دستور Agent: یک یا چند فایل
AGENTS.mdدر هر جای مخزن؛ نزدیکترین فایل در درخت پوشهها برتری دارد. بهجای آن میشود یکCLAUDE.mdیاGEMINI.mdدر ریشه گذاشت.
مستندات میگوید این فایلها بلافاصله بعد از ذخیره اثر میکنند و در پاسخ Chat، فایل .github/copilot-instructions.md در فهرست References دیده میشود، یعنی استفاده شده.
اولویت
دستورهای شخصی بالاترین اولویت را دارند، بعد دستورهای مخزن و بعد دستورهای سازمان. همهٔ مجموعههای مرتبط فرستاده میشوند؛ مستندات توصیه میکند مجموعههای متناقض ننویسی. بازبینی کد روی GitHub.com دستورها را از شاخهٔ سر pull request میخواند، نه شاخهٔ پایه.
توصیههای رسمی برای متن
نمونهٔ دستور آمادهسازی مخزن در مستندات این را میگوید:
- حداکثر دو صفحه باشد و مخصوص یک کار نباشد.
- دستورهای ساخت، راهاندازی، تست، لینت و اجرا را بنویس و هرکدام را با اجرای واقعی تأیید کن.
- از «همیشه» استفاده کن، مثلاً «همیشه پیش از ساخت
npm installرا اجرا کن». - ترتیب تستها و خطاهای شناختهشده با راهحلشان را بنویس.
- بگو به دستورها اعتماد کند و فقط اگر ناقص بودند جستجو کند.
یک نمونه
# Build and test
- Always run `npm install` before building.
- Build: `npm run build`. Tests: `npm test`.
# Conventions
- Use TypeScript strict mode.
- API handlers live in `src/api/`.
حالتها
در VS Code با انتخاب «Agent»، Copilot خودش فایلها را انتخاب میکند و برای رفع خطا تکرار میکند؛ بهطور پیشفرض اجرای دستورها را تأیید میکنی. فهرست مستندات حالت Plan را هم نام میبرد: پیش از تغییر کد، پژوهش و پیشنویس برنامه برای بازبینی تو. این حالتها اعتبار یا سهمیه مصرف میکنند؛ شرایطش را در حساب خودت ببین.
ایمنی
دستورهای مخزن در کنار کد و در دید همه است؛ هرگز رمز یا کلید در آن ننویس. نکتههای بیشتر: راهنمای استفادهٔ مسئولانه.
ادامه
فایلهای معادل در ابزارهای دیگر: CLAUDE.md، AGENTS.md در Codex و قواعد Cursor. مقایسهشان: مقایسهٔ ابزارهای کدنویسی.
سوالات متداول
راهنمای اصلی این بخش
کار مؤثر با ابزارهای هوش مصنوعی: پنج اصل مشترکتحریریهٔ سرنخ
تیم نویسندگان و آزمایشگران
ما چند نفریم که هر روز با ابزارهای هوش مصنوعی و اتوماسیون کار میکنیم. هر راهنمایی که اینجا میبینید اول روی کارِ خودمان امتحان شده و بعد نوشته شده است.