Menyesuaikan Gemini menggunakan file AGENTS.md

Berikan petunjuk khusus kepada Gemini di Android Studio untuk diikuti menggunakan satu atau beberapa file AGENTS.md. File AGENTS.md ditempatkan bersama file lain dalam basis kode Anda, sehingga mudah untuk memeriksanya ke sistem kontrol versi (VCS) dan membagikan petunjuk khusus project, aturan gaya coding, dan panduan lainnya kepada seluruh tim Anda.

Untuk memulai, ikuti langkah-langkah ini:

  1. Buat file AGENTS.md di mana saja dalam sistem file project Anda. Gemini memindai direktori saat ini dan semua direktori induk untuk menemukan file AGENTS.md saat Anda mengirimkan kueri. Untuk mengetahui detail selengkapnya, lihat Cara kerja file AGENTS.md.

  2. Tambahkan petunjuk Anda. Tulis petunjuk Anda menggunakan Markdown. Agar lebih mudah dibaca, pertimbangkan untuk menggunakan judul dan poin-poin untuk aturan yang berbeda. Lihat contoh petunjuk.

  3. Simpan dan lakukan commit file ke VCS Anda untuk membagikannya kepada tim Anda.

Mengelola file AGENTS.md sebagai konteks

Anda dapat menerapkan atau menghapus file AGENTS.md sebagai konteks untuk kueri tertentu menggunakan panel Konteks di panel chat. Opsi AGENTS.md File mencakup semua file AGENTS.md di direktori saat ini dan direktori induknya.

Mengelola file AGENTS.md sebagai konteks
Gambar 1. Mengelola file AGENTS.md sebagai konteks.

Contoh petunjuk

Anda dapat menggunakan file AGENTS.md untuk memberikan petunjuk kepada agen. Berikut adalah beberapa contoh, tetapi petunjuk yang Anda berikan harus spesifik untuk project Anda.

  • "Aktivitas utamanya adalah /path/to/MainActivity.kt."
  • "Kode untuk mendukung navigasi antar-layar adalah path/to/navigation/UiNavigation.kt"
  • "Kode yang menangani permintaan HTTP ada di <path>."
  • Arsitektur project
    • "Tempatkan semua logika bisnis di ViewModel."
    • "Selalu ikuti rekomendasi arsitektur resmi, termasuk penggunaan arsitektur berlayer. Gunakan aliran data searah (UDF), ViewModel, pengumpulan status UI yang mendukung siklus proses, dan rekomendasi lainnya."
  • Library pilihan: "Gunakan library <nama library> untuk navigasi."
  • Menentukan nama placeholder untuk layanan API umum atau terminologi internal: "Layanan backend utama disebut sebagai 'PhotoSift-API'."
  • Panduan gaya perusahaan: "Semua komponen UI baru harus dibangun dengan Jetpack Compose. Jangan menyarankan tata letak berbasis XML."

Membuat file AGENTS.md Anda menjadi modular

Anda dapat memecah file AGENTS.md besar menjadi file yang lebih kecil yang dapat digunakan kembali dalam konteks yang berbeda:

  1. Pisahkan serangkaian petunjuk dan simpan di file Markdown lain, seperti style-guidance.md.

  2. Referensi file Markdown yang lebih kecil dalam file AGENTS.md menggunakan simbol @ diikuti dengan jalur ke file yang ingin Anda impor. Format jalur berikut didukung:

    • Jalur relatif:
      • @./file.md - Mengimpor dari direktori yang sama
      • @../file.md - Impor dari direktori induk
      • @./subdirectory/file.md - Mengimpor dari subdirektori
    • Jalur absolut: @/absolute/path/to/file.md

Misalnya, file AGENTS.md berikut mereferensikan dua file instruksi lainnya:

# My AGENTS.md

You are an experienced Android app developer.

@./get-started.md

## Coding style

@./shared/style-guidance.md

Cara kerja file AGENTS.md

Gemini akan otomatis memindai direktori saat ini dan direktori induk untuk menemukan file AGENTS.md dan menambahkan kontennya ke awal setiap perintah sebagai pengantar. Jika Anda tidak membuka file saat mengirimkan kueri, file AGENTS.md di root project (jika ada) akan disertakan secara default.

Apa perbedaan antara file AGENTS.md dan Aturan?

Aturan juga memungkinkan Anda menentukan petunjuk dan preferensi yang berlaku untuk semua perintah. Namun, aturan ditentukan dalam file IntelliJ /.idea/project.prompts.xml, sedangkan file AGENTS.md disimpan di samping kode sumber Anda dan netral terhadap IDE. Sebaiknya gunakan file AGENTS.md jika salah satu tujuan utamanya adalah membagikan petunjuk kepada tim Anda.