Ulepszanie opisów żądań ściągnięcia przy użyciu szablonów
Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019
Pisanie dobrych opisów pull requestów to doskonały sposób, aby pomóc recenzentom zorientować się, czego mogą się spodziewać podczas przeglądania kodu. Jest to również doskonały sposób na śledzenie elementów, które należy wykonać dla każdej zmiany, takich jak testowanie, dodawanie testów jednostkowych i aktualizowanie dokumentacji. Szablony żądań ściągnięcia mogą pomóc deweloperom tworzyć doskonałe opisy żądań ściągnięcia spełniające standardy organizacji.
W tym artykule pokazano, jak rozpocząć pracę z szablonami żądań ściągnięcia.
Uwaga
Szablony pull request mogą zapewniać wskazówki, ale są tylko doradcze. Użyj zasad gałęzi, aby wymusić najlepsze praktyki, takie jak wymaganie żądań zatwierdzenia dla kluczowych gałęzi, takich jak gałąź główna, wymaganie pomyślnej kompilacji i wymuszanie obecności wymaganych recenzentów. Aby uzyskać więcej informacji, zobacz zasady oddziałów.
Wymagania wstępne
| Kategoria | Wymagania |
|---|---|
| Dostęp do projektu | Członek projektu . |
| uprawnienia | — Wyświetlanie kodu w projektach prywatnych: co najmniej dostęp na poziomie Podstawowym. — Klonowanie lub współtworzenie kodu w prywatnych projektach: członkostwo w grupie zabezpieczeń Współautorzy lub odpowiednie uprawnienia w projekcie. — Ustaw uprawnienia gałęzi lub repozytorium: Zarządzanie uprawnieniami dla gałęzi lub repozytorium. - Zmień gałąź domyślną: Edytuj zasady uprawnienia dla repozytorium. — Zaimportuj repozytorium: członek grupy zabezpieczeń Administratorzy projektów lub uprawnienia na poziomie projektu Git Utwórz repozytorium ustawione na Dozwolone. Aby uzyskać więcej informacji, zobacz Ustawianie uprawnień repozytorium Git. |
| Usługi | Repozytoria włączone. |
| Narzędzia | Opcjonalny. Użyj poleceń az repos: Azure DevOps CLI. |
Uwaga
W projektach publicznych użytkownicy z dostępem Stakeholder mają pełny dostęp do usługi Azure Repos, w tym wyświetlanie, klonowanie i współtworzenie kodu.
| Kategoria | Wymagania |
|---|---|
| Dostęp do projektu | Członek projektu . |
| uprawnienia | — Wyświetl kod: przynajmniej podstawowy dostęp. — Klonowanie lub współtworzenie kodu: członek grupy zabezpieczeń Współtwórców lub posiadający odpowiednie uprawnienia w projekcie. |
| Usługi | Repozytoria włączone. |
Co to jest szablon pull requesta?
Szablon żądania ściągnięcia to plik zawierający tekst markdown , który jest dodawany do opisu żądania ściągnięcia po utworzeniu żądania ściągnięcia.
Thank you for your contribution to the Fabrikam Fiber repo.
Before submitting this PR, please make sure:
- [ ] Your code builds clean without any errors or warnings
- [ ] You are using approved terminology
- [ ] You have added unit tests
Usługa Azure Repos umożliwia tworzenie następujących typów szablonów żądań ściągnięcia:
- Domyślny szablon żądania ściągnięcia, który jest automatycznie stosowany dla wszystkich nowych żądań ściągnięcia w repozytorium, chyba że zostanie zastąpiony przez szablon żądania ściągnięcia specyficznego dla gałęzi
- Szablony żądań ściągnięcia specyficzne dla gałęzi, które są automatycznie stosowane do żądań ściągnięcia przeznaczonych dla określonej gałęzi
- Dodatkowe szablony żądań ściągnięcia, które można opcjonalnie dodać przez twórcę żądania ściągnięcia
Typ szablonu żądania ściągnięcia jest określany przez jego nazwę pliku i lokalizację folderu, zgodnie z opisem w poniższych sekcjach. Nazwy plików i lokalizacje folderów nie są wrażliwe na wielkość liter, ale muszą znajdować się w domyślnej gałęzi repozytorium.
Uwaga
Wszystkie pliki szablonów pull request muszą znajdować się w domyślnej gałęzi (zazwyczaj Main) repozytorium. Używane są tylko pliki szablonów pull request z gałęzi domyślnej.
Domyślne szablony żądań ściągnięcia
Domyślne szablony pull requestów są automatycznie stosowane do pola opisu przy tworzeniu nowego pull requesta. Aby skonfigurować repozytorium przy użyciu domyślnego szablonu żądania ściągnięcia, utwórz plik o nazwie pull_request_template.md lub pull_request_template.txt i zapisz go w domyślnej gałęzi repozytorium w jednym z następujących folderów.
- Folder o nazwie
.azuredevops, który znajduje się w folderze głównym repozytorium - Folder o nazwie
.vsts, który znajduje się w folderze głównym repozytorium - Folder o nazwie
docs, który znajduje się w folderze głównym repozytorium - Folder główny repozytorium
Dostępnych jest wiele lokalizacji, które umożliwiają elastyczne przechowywanie szablonów pull request. Po utworzeniu żądania ściągnięcia usługa Azure Repos przeszukuje wyznaczone foldery w podanej kolejności i używa pierwszego domyślnego szablonu żądania ściągnięcia, który znajdzie.
Po utworzeniu nowego żądania połączenia w repozytorium, chyba że zostanie zastosowany szablon wniosku o połączenie dla konkretnej gałęzi, zawartość domyślnego szablonu wniosku o połączenie jest używana do wstępnego wypełnienia pola opisu w żądaniu połączenia.
W razie potrzeby możesz edytować lub dodawać do tego opisu i dołączać dodatkowe szablony żądań ściągnięcia , wybierając je z listy rozwijanej Dodaj szablon .
Uwaga
Gdy domyślny lub specyficzny dla gałęzi szablon żądania ściągnięcia jest automatycznie stosowany, zastępuje standardowe komunikaty zatwierdzenia, które są zwykle używane dla domyślnego opisu. Możesz je dodać z powrotem, wybierając pozycję Dodaj komunikaty zatwierdzenia.
Szablony żądań ściągnięcia specyficzne dla gałęzi
Szablony żądań ściągnięcia specyficzne dla gałęzi można skonfigurować dla żądań ściągnięcia przeznaczonych dla określonej gałęzi. Aby skonfigurować repozytorium przy użyciu szablonu żądania pobrania specyficznego dla gałęzi, utwórz plik .txt lub .md o nazwie zgodnej z nazwą gałęzi. Nazwa musi być zgodna z pierwszym poziomem nazwy gałęzi, takim jak main, dev, releaselub feature. Każdy szablon żądania ściągnięcia specyficzny dla gałęzi jest stosowany za każdym razem, gdy żądanie ściągnięcia będzie dotyczyć tej gałęzi lub dowolnych gałęzi znajdujących się w niej. Na przykład szablon żądania pull request o nazwie feature.md zostanie zastosowany, jeśli żądanie dotyczy gałęzi feature lub jakiejkolwiek gałęzi feature/*.
Szablony żądań ściągnięcia specyficzne dla gałęzi muszą być zapisane w domyślnej gałęzi repozytorium przy użyciu następującej hierarchii folderów: pull_request_template/branches/. Te foldery muszą znajdować się w jednym z następujących folderów w repozytorium.
- Folder o nazwie
.azuredevops, który znajduje się w folderze głównym repozytorium - Folder o nazwie
.vsts, który znajduje się w folderze głównym repozytorium - Folder o nazwie
docs, który znajduje się w folderze głównym repozytorium - Folder główny repozytorium
Na przykład szablon żądania ściągnięcia specyficzny dla gałęzi, który powinien być stosowany do wszystkich żądań ściągnięcia do dev gałęzi, ma nazwę dev.md lub dev.txt znajduje się w jednej z następujących lokalizacji.
<repository root>/.azuredevops/pull_request_template/branches/<repository root>/.vsts/pull_request_template/branches/<repository root>/docs/pull_request_template/branches/<repository root>/pull_request_template/branches/
Podobnie jak domyślne szablony żądań ściągnięcia, udostępnia się wiele lokalizacji, które zapewniają elastyczność przechowywania szablonów żądań ściągnięcia specyficznych dla gałęzi. Po utworzeniu żądania ściągnięcia usługa Azure Repos przeszukuje wyznaczone foldery w kolejności podanej dla szablonu żądania ściągnięcia specyficznego dla gałęzi i używa pierwszego znalezionego elementu zgodnego z nazwą gałęzi. Jeśli nie znaleziono szablonu żądania ściągnięcia dla określonej gałęzi, usługa Azure Repos wyszukuje domyślny szablon żądania ściągnięcia zgodnie z opisem w poprzedniej sekcji Domyślne szablony żądań ściągnięcia .
Dodatkowe szablony pull requestów
Oprócz domyślnych i specyficznych dla gałęzi szablonów pull requestów, można skonfigurować dodatkowe szablony. Mogą to być pliki .md lub .txt, znajdujące się w jednym z następujących folderów w gałęzi domyślnej.
<repository root>/.azuredevops/pull_request_template/<repository root>/.vsts/pull_request_template/<repository root>/docs/pull_request_template/<repository root>/pull_request_template/
Po utworzeniu żądania ściągnięcia możesz dołączyć dowolny z dostępnych szablonów, wybierając go z listy rozwijanej Dodaj szablon. Nazwy na liście rozwijanej są oparte na nazwach plików szablonów.
Na poniższej liście znajdują się trzy szablony.
-
dev.md— Jest to szablon specyficzny dla gałęzi, który został zastosowany domyślnie w tym pull request do gałęzi dev, jak wskazuje komunikat domyślny wymieniony po nazwie pliku. -
additional.md— Jest to dodatkowy szablon. -
pull_request_template.md— Jest to zwykle szablon domyślny, ale został zastąpiony przezdev.mdszablon specyficzny dla gałęzi w tym żądaniu ściągnięcia. Mimo że nie został on dodany domyślnie, nadal można go zastosować, wybierając go z listy.
Wybierz nazwę żądanego dodatkowego szablonu, aby dołączyć jego zawartość do bieżącego opisu żądania ściągnięcia.
Uwaga
Możesz określić szablon żądania ściągnięcia, aby zastąpić dowolne zgodne domyślne lub specyficzne dla gałęzi żądanie ściągnięcia, dołączając ?template=name.md do ciągu zapytania.