Dostosowywanie Gemini za pomocą plików AGENT.md

Podaj Gemini w Android Studio niestandardowe instrukcje, których ma przestrzegać, używając co najmniej 1 AGENT.mdpliku. Pliki AGENT.md są umieszczane obok innych plików w bazie kodu, więc można je łatwo zarejestrować w systemie kontroli wersji (VCS) i udostępnić całemu zespołowi instrukcje dotyczące projektu, reguły stylu kodowania i inne wskazówki.

Aby zacząć go używać, wykonaj te czynności:

  1. Utwórz plik AGENT.md w dowolnym miejscu w systemie plików projektu. Gdy przesyłasz zapytanie, Gemini skanuje bieżący katalog i wszystkie katalogi nadrzędne w poszukiwaniu plików AGENT.md. Więcej informacji znajdziesz w artykule Jak działają pliki AGENT.md.

  2. Dodaj instrukcje. Napisz instrukcje w języku Markdown. Aby zwiększyć czytelność, używaj nagłówków i wypunktowań dla różnych reguł. Zobacz przykładowe instrukcje

  3. Zapisz i zatwierdź plik w systemie kontroli wersji, aby udostępnić go zespołowi.

Zarządzanie plikami AGENT.md jako kontekstem

Możesz zastosować lub usunąć pliki AGENT.md jako kontekst dla konkretnego zapytania, korzystając z panelu Kontekst w oknie czatu. Opcje AGENT.mdPliki obejmują wszystkie AGENT.mdpliki w bieżącym katalogu i jego katalogach nadrzędnych.

Zarządzanie plikami AGENT.md jako kontekstem
Rysunek 1. zarządzać plikami AGENT.md jako kontekstem
;

Przykładowe instrukcje

Za pomocą pliku AGENT.md możesz przekazać agentowi instrukcje. Poniżej znajdziesz kilka przykładów, ale podane przez Ciebie instrukcje powinny być dostosowane do Twojego projektu.

  • „Główna aktywność to /path/to/MainActivity.kt”.
  • „Kod umożliwiający przechodzenie między ekranami to: path/to/navigation/UiNavigation.kt”
  • „Kod obsługujący żądania HTTP znajduje się w lokalizacji <path>”.
  • Architektura projektu
    • „Całą logikę biznesową umieszczaj w klasach ViewModel”.
    • „Zawsze postępuj zgodnie z oficjalnymi zaleceniami dotyczącymi architektury, w tym z zaleceniami dotyczącymi stosowania architektury warstwowej. Używaj jednokierunkowego przepływu danych (UDF), ViewModeli, zbierania stanu interfejsu użytkownika uwzględniającego cykl życia i innych zaleceń”.
  • Preferowane biblioteki: „Używaj biblioteki <nazwa biblioteki> do nawigacji”.
  • Określanie nazw zastępczych dla popularnych usług API lub terminologii wewnętrznej: „Podstawowa usługa backendu jest nazywana „PhotoSift-API””.
  • Przewodniki po stylu firmy: „Wszystkie nowe komponenty interfejsu muszą być tworzone za pomocą Jetpack Compose. Nie proponuj układów opartych na XML-u”.

Podziel pliki AGENT.md na moduły

Duże pliki AGENT.md możesz podzielić na mniejsze, które można ponownie wykorzystać w różnych kontekstach:

  1. wydzielić zestaw instrukcji i zapisać go w innym pliku Markdown, np. style-guidance.md;

  2. Odwołuj się do mniejszych plików Markdown w pliku AGENT.md, używając symbolu @ i ścieżki do pliku, który chcesz zaimportować. Obsługiwane są te formaty ścieżek:

    • Ścieżki względne:
      • @./file.md – importowanie z tego samego katalogu
      • @../file.md – importowanie z katalogu nadrzędnego
      • @./subdirectory/file.md – importowanie z podkatalogu;
    • Ścieżki bezwzględne: @/absolute/path/to/file.md

Na przykład ten plik AGENT.md odwołuje się do 2 innych plików z instrukcjami:

# My AGENT.md

You are an experienced Android app developer.

@./get-started.md

## Coding style

@./shared/style-guidance.md

Jak działają pliki AGENT.md

Gemini automatycznie skanuje bieżący katalog i katalogi nadrzędne w poszukiwaniu plików AGENT.md i dodaje ich zawartość na początku każdego prompta jako wstęp. Jeśli w momencie przesyłania zapytania nie masz otwartego pliku, domyślnie uwzględniany jest AGENT.mdplik w katalogu głównym projektu (jeśli taki istnieje).

Czym różnią się pliki AGENT.md od reguł?

Reguły umożliwiają też określanie instrukcji i preferencji, które mają zastosowanie do wszystkich promptów. Reguły są jednak zdefiniowane w pliku IntelliJ/.idea/project.prompts.xml, a pliki AGENT.md są zapisywane obok kodu źródłowego i nie są powiązane z żadnym konkretnym środowiskiem IDE. Jeśli jednym z głównych celów jest udostępnienie instrukcji zespołowi, zalecamy używanie plików AGENT.md.