Konfigurowanie instrukcji przeglądu kodu w Copilot

Azure DevOps Services

Important

Ta funkcja jest dostępna w publicznej wersji zapoznawczej.

Użyj niestandardowych instrukcji, aby dostosować zachowanie przeglądu kodu Copilot na poziomach organizacji, projektu i repozytorium. Instrukcje niestandardowe kierują Copilotem, aby skupił się na określonych standardach kodowania, najlepszych praktykach lub zasadach organizacji.

Wymagania wstępne

Kategoria Requirements
Włączanie funkcji Copilot code review musi być włączony na poziomach organizacji, projektu i repozytorium.
Uprawnienia organizacji Uprawnienia administratora kolekcji projektów do dodawania lub modyfikowania niestandardowych instrukcji na poziomie organizacji.
Uprawnienia projektu Uprawnienia administratora projektu do dodawania lub modyfikowania instrukcji niestandardowych na poziomie projektu.
Uprawnienia repozytorium Uprawnienia do wypychania lub uprawnienia administratora do repozytorium w celu dodania lub zmodyfikowania niestandardowych instrukcji na poziomie repozytorium.

Niestandardowe zakresy instrukcji

Instrukcje niestandardowe można zdefiniować w wielu zakresach:

  • Poziom organizacji: Standardy bazowe, które mają zastosowanie we wszystkich projektach.
  • Poziom projektu: standardy specyficzne dla zespołu lub projektu.
  • Poziom repozytorium: Standardy specyficzne dla repozytorium w systemie .github/copilot-instructions.md lub .azuredevops/copilot-instructions.md.

Gdy instrukcje istnieją w wielu zakresach, Copilot używa wszystkich odpowiednich instrukcji podczas przeglądu.

Note

Copilot odczytuje pliki instrukcji na poziomie repozytorium i ścieżki tylko z gałęzi docelowej pull requestu. Zmiany w plikach instrukcji w pull requeście nie mają wpływu na jego przegląd. Copilot używa zmian dopiero po scaleniu ich do gałęzi docelowej.

Niestandardowe instrukcje organizacji i projektu

Skonfiguruj instrukcje niestandardowe na poziomie organizacji i na poziomie projektu w ustawieniach Azure DevOps. Użyj tych zakresów dla ogólnych zasad, takich jak wymagania dotyczące zabezpieczeń, reguły zgodności lub konwencje językowe współużytkowane przez wiele repozytoriów.

Plik niestandardowych instrukcji repozytorium

Przechowuj niestandardowe instrukcje w pliku .github/copilot-instructions.md lub .azuredevops/copilot-instructions.md w katalogu głównym repozytorium. Copilot odczytuje ten plik podczas każdej recenzji, aby zrozumieć konkretne wytyczne repozytorium.

.github/
   copilot-instructions.md
   instructions/
      api.instructions.md

.azuredevops/                       # same files work here too
   copilot-instructions.md
   instructions/
      api.instructions.md

Utwórz niestandardowe instrukcje

  1. W repozytorium utwórz folder .github lub .azuredevops, jeśli jeszcze nie istnieje.
  2. Utwórz nowy plik o nazwie copilot-instructions.md w folderze .github lub .azuredevops.
  3. Dodaj niestandardowe instrukcje w formacie Markdown.
  4. Zatwierdź i wypchnij plik do repozytorium.

Dodaj instrukcje o zakresie ograniczonym do ścieżki

Użyj plików instrukcji dla określonej ścieżki, jeśli chcesz użyć różnych reguł dla określonych folderów, typów plików lub technologii.

  • Utwórz co najmniej jeden *.instructions.md plik w .github/instructions/ lub .azuredevops/instructions/.
  • Dodaj sekcję nagłówkową YAML z wartością applyTo, która wskazuje pasujące pliki.
  • Zachowaj wskazówki skoncentrowane na jednym języku lub problemie na plik.

Copilot stosuje reguły ograniczone do ścieżki tylko do zmienionych plików, które pasują do wzorców applyTo.

Format pliku ograniczony do ścieżki

---
applyTo: "**/*.ts,**/*.tsx"
---

## TypeScript standards

- Avoid `any`; prefer `unknown` or a specific type.
- Prefer `const`; avoid `var`.
- Use optional chaining (`?.`) and nullish coalescing (`??`) where appropriate.

przykłady wzorca applyTo

  • applyTo: "**" dotyczy wszystkich plików.
  • applyTo: "**/*.cs" dotyczy wszystkich plików C#.
  • applyTo: "**/*.sql,**/Settings.xml" dotyczy wielu wzorców.

Jeśli plik ograniczony do ścieżki nie zawiera applyTo, Copilot pomija ten plik.

Najlepsze praktyki dotyczące instrukcji niestandardowych

  • Bądź konkretny: Podaj jasne, praktyczne wskazówki dotyczące typów problemów, które Copilot powinien oznaczać.
  • Skoncentruj się na obszarach o dużym wpływie: Nadaj priorytet jakości, bezpieczeństwu i wydajności kodu istotnym dla Twojej bazy kodu.
  • Dołącz przykłady: W razie potrzeby podaj przykłady problemów w kodzie, na które należy zwracać uwagę, lub wzorce, których należy unikać.
  • Zachowaj zwięzłość: Copilot przetwarza cały plik dla każdej recenzji, dlatego należy mówić wprost i unikać rozwlekłych wyjaśnień.
  • Regularnie aktualizuj: Przejrzyj i zaktualizuj instrukcje w miarę rozwoju standardów kodowania.

Przykładowe instrukcje niestandardowe

# Copilot code review instructions

## Security focus
- Flag any hardcoded credentials, API keys, or sensitive data
- Identify potential SQL injection or XSS vulnerabilities
- Check for secure use of cryptographic functions

## Performance considerations
- Suggest database query optimizations
- Identify N+1 query problems
- Flag inefficient loops or algorithms

## Team coding standards
- Enforce naming conventions (camelCase for variables, PascalCase for classes)
- Check for proper error handling and logging
- Ensure consistent use of async/await patterns

## Documentation requirements
- Flag missing or incomplete function documentation
- Verify that complex logic includes explanatory comments

Poziom organizacji

Dodaj niestandardowe instrukcje na poziomie organizacji, aby zdefiniować szerokie standardy weryfikacji w przedsiębiorstwie.

Instrukcje na poziomie organizacji wpływają na przegląd kodu Copilot dla wszystkich projektów i wszystkich repozytoriów w tej organizacji, dlatego należy ich używać do wymagań, które powinny być przestrzegane przez każdy zespół.

Zrzut ekranu przedstawiający konfigurację instrukcji niestandardowych na poziomie organizacji z ustawieniami dotyczącymi wszystkich projektów i repozytoriów w organizacji.

Poziom projektu

Dodaj niestandardowe instrukcje na poziomie projektu, aby zdefiniować wspólne standardy przeglądu we wszystkich repozytoriach projektów.

Instrukcje na poziomie projektu mają wpływ na przegląd kodu Copilot we wszystkich repozytoriach w tym projekcie, dlatego należy ich używać do określania konwencji, których powinien przestrzegać każdy zespół w projekcie.

Zrzut ekranu przedstawiający konfigurację instrukcji niestandardowych na poziomie projektu z ustawieniami dotyczącymi wszystkich repozytoriów w projekcie.

Kolejność pierwszeństwa

Gdy instrukcje nakładają się na siebie, Copilot stosuje je w tej kolejności pierwszeństwa:

  1. Instrukcje na poziomie repozytorium
  2. Instrukcje na poziomie projektu
  3. Instrukcje na poziomie organizacji

Instrukcje dotyczące repozytorium mają najwyższy priorytet, a następnie instrukcje na poziomie projektu, a następnie instrukcje na poziomie organizacji.

Jeśli dwie instrukcje powodują konflikt, Copilot używa instrukcji z zakresem wyższego pierwszeństwa.

Note

Kolejność pierwszeństwa określa sposób działania przeglądu w Copilot, ale nie jest gwarantowana. Ponieważ Copilot używa dużego modelu językowego, czasami może interpretować lub stosować sprzeczne instrukcje w różny sposób.

Uzyskaj pomoc

Aby rozwiązać problemy związane z instrukcjami niestandardowymi i uzyskać odpowiedzi na często zadawane pytania dotyczące przeglądu kodu w Copilot, zobacz Rozwiązywanie problemów z przeglądem kodu w Copilot.

Następny krok