Lekéréses kérelmek leírásának javítása sablonok használatával

Azure DevOps Services | 2022 Azure DevOps Server – 2019 Azure DevOps Server

A jó lekéréses kérelmek leírásának megírása nagyszerű módja annak, hogy a véleményezők tudják, mire számíthatnak a kód áttekintésekor. Emellett kiválóan segítenek nyomon követni azokat a dolgokat, amelyeket minden módosításhoz el kell végezni, például a teszteléshez, az egységtesztek hozzáadásához és a dokumentáció frissítéséhez. A lekéréses kérelmek sablonjai segítségével a fejlesztők nagyszerű lekéréses kérelemleírásokat hozhatnak létre, amelyek megfelelnek a szervezet szabványainak.

Ez a cikk bemutatja, hogyan kezdheti el a lekéréses kérelmek sablonjait.

Megjegyzés

A lekéréses kérelmek sablonjai útmutatást nyújthatnak, de csak tanácsadást nyújtanak. Ágszabályzatok használatával érvényesítheti az ajánlott eljárásokat, például lekéréses kérelmeket követelhet meg a főágakhoz, sikeres buildelést igényelhet, és kényszerítheti a szükséges felülvizsgálókat. További információ: Ágszabályzatok.

Mi az a lekéréses kérelemsablon?

A lekéréses kérelmek sablonja egy Markdown-szöveget tartalmazó fájl, amelyet a lekéréses kérelem létrehozásakor a rendszer hozzáad a lekéréses kérelem leírásához.

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

Az Azure Repos lehetővé teszi a következő típusú lekéréses kérelmek sablonjainak létrehozását:

• Alapértelmezett lekéréses kérelemsablon, amelyet a rendszer automatikusan alkalmaz az adattárban található összes új lekéréses kérelemre, kivéve, ha egy ágspecifikus lekéréses kérelemsablon felülírja
• Ágspecifikus lekéréses kérelemsablonok, amelyeket a rendszer automatikusan alkalmaz egy adott ágat megcélzó lekéréses kérelmekre
• A lekéréses kérelem létrehozója által opcionálisan hozzáadható további lekéréses kérelmek sablonjai

A lekéréses kérelmek sablonjának típusát a fájlnév és a mappa helye határozza meg, az alábbi szakaszokban leírtak szerint. A fájlnevek és a mappahelyek nem különböztetik meg a kis- és nagybetűket, de az adattár alapértelmezett ágában kell lenniük.

Megjegyzés

Minden lekéréses kérelemsablonfájlnak az adattár alapértelmezett ágában (általában fő) kell lennie. A rendszer csak az alapértelmezett ágból származó lekéréses kérelemsablonfájlokat használja.

Alapértelmezett lekéréses kérelemsablonok

Új lekéréses kérelem létrehozásakor a rendszer automatikusan alkalmazza az alapértelmezett lekéréses kérelmek sablonjait a leírásmezőre. Ha az adattárat egy alapértelmezett lekéréses kérelemsablonnal szeretné konfigurálni, hozzon létre egy nevű pull_request_template.md fájlt, vagy pull_request_template.txt mentse az adattár alapértelmezett ágába az alábbi mappák egyikében.

• Az adattár gyökérmappájában található nevű .azuredevops mappa
• Az adattár gyökérmappájában található nevű .vsts mappa
• Az adattár gyökérmappájában található nevű docs mappa
• Az adattár gyökérmappája

Több helyen is rugalmasan tárolhatja a lekéréses kérelmek sablonjait. Lekéréses kérelem létrehozásakor az Azure Repos a megadott sorrendben keres a kijelölt mappákban, és az első alapértelmezett lekéréses kérelemsablont használja.

Ha új lekéréses kérelem jön létre az adattárban, hacsak nem alkalmaz ágspecifikus lekéréses kérelemsablont , a rendszer az alapértelmezett lekéréses kérelemsablon tartalmát használja a lekéréses kérelem leírásmezőjének előre feltöltéséhez.

Igény szerint szerkesztheti vagy hozzáadhatja ezt a leírást, és szükség esetén további lekéréses kérelmek sablonjait is hozzáfűzheti a Sablon hozzáadása legördülő listából.

Megjegyzés

Ha automatikusan alkalmaz egy alapértelmezett vagy ágspecifikus lekéréses kérelemsablont, az az alapértelmezett leíráshoz általában használt szabványos véglegesítési üzeneteket váltja fel. A véglegesítési üzenetek hozzáadása lehetőséget választva hozzáadhatja őket.

Ágspecifikus lekéréses kérelemsablonok

Az ágspecifikus lekéréses kérelmek sablonjai konfigurálhatók egy adott ágat megcélzó lekéréses kérelmekhez. Ha az adattárat egy ágspecifikus lekéréses kérelemsablonnal szeretné konfigurálni, hozzon létre egy .txt vagy .md egy, az ágról elnevezett fájlt. A névnek meg kell egyeznie az ágnév első szintjével, például main, dev, releasevagy feature. Minden ágspecifikus lekéréses kérelemsablont a rendszer minden alkalommal alkalmaz, amikor egy lekéréses kérelem az adott ágat vagy a benne található ágakat célozza meg. Például a nevű feature.md lekéréses kérelemsablon akkor lesz alkalmazva, ha egy lekéréses kérelem az feature ágat vagy bármely feature/* ágat célozza.

Az ágspecifikus lekéréses kérelmek sablonjait az adattár alapértelmezett ágába kell menteni a következő mappahierarchiával: pull_request_template/branches/. Ezeknek a mappáknak az adattár alábbi mappáinak egyikén kell alapulnia.

• Az adattár gyökérmappájában található nevű .azuredevops mappa
• Az adattár gyökérmappájában található nevű .vsts mappa
• Az adattár gyökérmappájában található nevű docs mappa
• Az adattár gyökérmappája

Például egy ágspecifikus lekéréses kérelemsablon, amelyet az dev ágba irányuló összes lekéréses kérelemre alkalmazni kell, a következő helyek egyikén lesz elnevezve dev.md vagy dev.txt elhelyezve.

• <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/

Az alapértelmezett lekéréses kérelmek sablonjaihoz hasonlóan több hely is rendelkezésre áll, így rugalmasan tárolhatja az ágspecifikus lekéréses kérelmek sablonjait. Lekéréses kérelem létrehozásakor az Azure Repos egy ágspecifikus lekéréses kérelemsablonhoz megadott sorrendben keres a kijelölt mappákban, és az elsőt használja, amely megfelel az ág nevének. Ha nem található ágspecifikus lekéréses kérelemsablon, az Azure Repos ezután megkeres egy alapértelmezett lekéréses kérelemsablont az előző Alapértelmezett lekéréses kérelemsablonok szakaszban leírtak szerint.

További lekéréses kérelmek sablonjai

Az alapértelmezett és ágspecifikus lekéréses kérelmek sablonjai mellett további lekéréses kérelmek sablonjait is konfigurálhatja. Ezek lehetnek .md vagy .txt fájlok, az alapértelmezett ág következő mappáinak egyikében találhatók.

• <repository root>/.azuredevops/pull_request_template/
• <repository root>/.vsts/pull_request_template/
• <repository root>/docs/pull_request_template/
• <repository root>/pull_request_template/

Lekéréses kérelem létrehozásakor az elérhető lekéréses kérelemsablonok bármelyikét hozzáfűzheti, ha kiválasztja őket a Sablon hozzáadása legördülő listából. A legördülő menüben szereplő nevek a sablonok fájlnevén alapulnak.

Az alábbi példában három sablon látható.

• dev.md – Ez az a ágspecifikus sablon, amelyet alapértelmezés szerint erre a lekéréses kérelemre alkalmaztak a fejlesztői ágban, ahogy azt a fájlnév után megjelenő alapértelmezett üzenet is jelzi.
• additional.md – Ez egy további sablon.
• pull_request_template.md – Ez általában az alapértelmezett sablon, de a lekéréses kérelem ágspecifikus sablonja felülírta dev.md . Annak ellenére, hogy alapértelmezés szerint nem lett hozzáadva, továbbra is alkalmazható a listából való kijelöléssel.

Válassza ki a kívánt további sablon nevét, és fűzze hozzá a tartalmát az aktuális lekéréses kérelem leírásához.

Megjegyzés

A lekérdezési sztringhez hozzáfűzve ?template=name.md megadhat egy lekéréses kérelemsablont az egyező alapértelmezett vagy ágspecifikus lekéréses kérelmek felülbírálásához.

Lásd még

• Lekéréses kérelem létrehozása a kód áttekintéséhez és egyesítéséhez
• Az ágak és ágszabályzatok ismertetése