Konfigurowanie instrukcji przeglądu kodu Copilot

usługi Azure DevOps

Użyj niestandardowych instrukcji, aby dostosować zachowanie przeglądu kodu Copilot na poziomach organizacji, projektu i repozytorium. Przewodnik instrukcji niestandardowych Copilot, aby skoncentrować się na określonych standardach kodowania, najlepszych rozwiązaniach lub zasadach organizacji.

Wymagania wstępne

Niestandardowe zakresy instrukcji

Instrukcje niestandardowe można zdefiniować w wielu zakresach:

• Poziom organizacji: Standardy bazowe, które mają zastosowanie we wszystkich projektach.
• Project poziom: standardy specyficzne dla zespołu lub project.
• 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.

Niestandardowe instrukcje dotyczące organizacji i projektu

Skonfiguruj instrukcje niestandardowe na poziomie organizacji i na poziomie projektu w ustawieniach Azure DevOps. Użyj tych zakresów dla szerokich 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 .github/copilot-instructions.md katalogu głównym repozytorium lub .azuredevops/copilot-instructions.md w katalogu głównym. 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

Tworzenie niestandardowych instrukcji

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

Dodawanie instrukcji dotyczących zakresu ścieżki

Użyj plików instrukcji o zakresie ś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 elemecie .github/instructions/ lub .azuredevops/instructions/.
• Dodaj sprawę frontonu YAML z wartością, która jest przeznaczona applyTo dla pasujących plików.
• Zachowaj wskazówki skoncentrowane na jednym języku lub problemie dla każdego pliku.

Copilot stosuje reguły o zakresie ścieżki tylko do zmienionych plików pasujących do applyTo wzorców.

Format pliku o zakresie ś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 wzorców applyTo

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

Jeśli plik o zakresie ścieżki nie zawiera applyTopliku , Copilot pomija ten plik.

Najlepsze rozwiązania dotyczące instrukcji niestandardowych

• Należy stosować konkretne charakterystyczne informacje: Podaj jasne, możliwe do działania wskazówki dotyczące typów problemów, Copilot powinny oznaczać flagę.
• Skoncentruj się na obszarach o dużym wpływie: Określanie priorytetów dotyczących jakości, bezpieczeństwa i wydajności kodu związanych z bazą kodu.
• Dołącz przykłady: W razie potrzeby podaj przykłady problemów z kodem, które należy wyszukać lub wzorce, których można uniknąć.
• Zachowaj zwięzłość: Copilot przetwarza cały plik dla każdej recenzji, dlatego należy zachować bezpośredni i uniknąć pełnych 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 przeglądu 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ół.

Poziom projektu

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

Project instrukcje na poziomie mają wpływ na przegląd kodu Copilot dla wszystkich repozytoriów w tym project, dlatego należy używać ich do konwencji, które powinny być przestrzegane przez każdy zespół w project.

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 Project
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.

Uzyskaj pomoc

Aby uzyskać instrukcje niestandardowe i odpowiedzi na często zadawane pytania dotyczące Copilot przeglądu kodu, zobacz Rozwiązywanie problemów z Copilot przeglądem kodu.

Następny krok

Treści powiązane

• Rozwiązywanie problemów z przeglądem kodu Copilot
• Wprowadzenie do przeglądu kodu Copilot
• Informacje o niestandardowych instrukcjach dotyczących GitHub Copilot
• Przeglądanie pull requestów
• Konfigurowanie zasad gałęzi