Granska och skicka en pull-begäran

5 minuter

Pull-begäran (PR) är din biljett för att få dina kunskaper till Learn-plattformen. Du har skapat en PR, men den har ännu inte skickats till mållagringsplatsens PR-kö. Precis som med många projekt med öppen källkod finns det en rad kontroller och granskningar som görs för att verifiera ändringar innan du publicerar.

En PR-anatomi

Skärmbild av en öppen pull-begäran.

En PR visar GitHub-användaren som skapade PR, mållagringsplatsen och den gren där PR skapades. PR:erna innehåller flera flikar överst, inklusive:

Fliken Konversation: En instrumentpanel där du kan visa och svara på kommentarer från andra medarbetare, se en lista med meddelanden under hela bygg- och granskningsprocessen och använda kommentarsautomation för att utföra åtgärder.
Fliken Incheckningar: En post med de ändringar som har gjorts i den grenen.
Fliken Filer har ändrats: En jämförelse av de ändrade filerna i PR med deras tidigare tillstånd.

Var noga med fliken Konversation, där alla uppdateringar eller meddelanden visas och eventuella diskussioner mellan dig, granskarna och andra medarbetare äger rum. Du kan också lägga till hashtaggkommentar här för att utföra åtgärder, till exempel att logga ut på PR för att indikera att den är redo att verifieras och sammanfogas, eller vänta om du behöver pausa processen.

PR:er har ofta etiketter kopplade för att ange deras status, till exempel draft för att ange utkast till PR:er som inte är redo för granskning eller do-not-merge för PR:er som är nya eller ej granskade.

Validering

Innan din pr kan sammanfogas till målgrenen kan det krävas att du går igenom en eller flera PR-valideringsprocesser. När du har valt Skapa pull-begäran kör GitHub valideringarna som konfigurerats för lagringsplatsen. När valideringsprocessen är klar visas resultatet i PR.

Valideringsprocesserna varierar beroende på omfattningen av föreslagna ändringar och reglerna för mållagringsplatsen. När du har skickat in din pr kan du förvänta dig att ett eller flera av följande händer:

Sammanslagningsbarhet: Ett gitHub-baslinjetest för sammanfogning sker först för att kontrollera om de föreslagna ändringarna i din gren står i konflikt med målgrenen. Om PR anger att det här testet misslyckades måste du stämma av innehållet som orsakar sammanslagningskonflikten innan bearbetningen kan fortsätta.
Licensavtal för bidrag (CLA): Om du bidrar till en offentlig lagringsplats och inte är anställd på Microsoft, beroende på omfattningen av de föreslagna ändringarna, kan du bli ombedd att slutföra ett kort CLA första gången du skickar en PR till lagringsplatsen. När CLA-steget har rensats bearbetas din pr.
Etikettering: Etiketter tillämpas automatiskt på din pr för att ange dess tillstånd när det passerar genom valideringsarbetsflödet. Till exempel kan nya PR:er automatiskt ta emot do-not-merge etiketten, vilket indikerar att PR ännu inte har slutfört verifierings-, gransknings- och signeringsstegen.
Validering och version: Kontrollerar automatiskt om ändringarna godkänns i valideringstesterna. Valideringstesterna kan ge varningar eller fel, vilket kräver att du gör ändringar i en eller flera filer i din PR innan den kan sammanfogas. Valideringstestresultatet läggs till som en kommentar i din PR för din granskning, och de kan också skickas till dig via e-post.
Mellanlagring: De artikelsidor som påverkas av ändringarna distribueras automatiskt till en mellanlagringsmiljö för granskning efter lyckad validering och version. Granska URL:erna som visas i pull-begärans kommentar.
Automatisk sammanslagning: Pr kan sammanfogas automatiskt om den klarar valideringstestning och vissa kriterier. I det här fallet behöver du inte göra något annat.

Granska och signera

Nästan klar! När all PR-bearbetning har slutförts är det bästa praxis att granska resultaten (till exempel PR-kommentarer, förhandsversions-URL:er) för att avgöra om fler ändringar krävs innan du loggar ut för sammanslagning. Om en PR-granskare har granskat din pr kan de också ge feedback via kommentarer om det finns kvarstående problem eller frågor som förhindrar sammanfogningen.

Använd kommentarsautomatisering för att utföra viktiga åtgärder i PR. Med kommentarsautomatisering kan användarna tilldela lämplig etikett till sin pr för att uppdatera sitt tillstånd eller kategorisera det. Om du arbetar på en lagringsplats där kommentarsautomation har implementerats använder du hashtaggkommentarna för att tilldela eller ändra etiketter, stänga en PR eller pausa sammanslagningen. När du till exempel är klar med att göra ändringar skriver du kommentaren #sign-off för att ändra pr-etiketten från do-not-merge till ready-for-review.

Använd kommentarerna i följande tabell för att utföra viktiga åtgärder i din PR:

Hashtaggkomment	Vad den gör
`#sign-off`	Tilldelar `ready-to-merge` automatiskt etiketten för att låta granskarna på lagringsplatsen veta att PR:en är redo för granskning/sammanslagning. Om du inte är den listade författaren och försöker logga ut på en offentlig lagringsplats-PR med hjälp av kommentaren `#sign-off` uppdateras PR för att indikera att endast författaren kan tilldela etiketten.
`#hold-off`	Tar `ready-to-merge` bort etiketten om du ändrar dig eller gör ett misstag.
`#please-close`	Stänger PR om du bestämmer dig för att inte koppla ändringarna.
`#please-open`	Öppnar en stängd pr eller ett problem igen.

Du måste ange kommentaren #sign-off för att sammanfoga ändringarna. Även om alla granskningar och valideringskontroller godkänns ansvarar du för att använda den här kommentaren för att berätta för PR-granskare och repoadministratörer att dina ändringar är redo för sammanslagning från din sida av saker. När granskarna fastställer att din pr är problemfri och signerad sammanfogas dina ändringar tillbaka till den överordnade grenen och PR stängs.

Skärmbild av kommentarsrutan på en PR med #sign skrivs in i kommentarsfältet och kommentarsknappen markerad.

Publicera

Kom ihåg att din PR måste sammanfogas av en PR-granskare innan ändringarna kan inkluderas i nästa schemalagda publiceringskörning. Normalt granskas och slås PR:er samman i ordningen för inlämning.

När dina bidrag har godkänts och slagits samman hämtar publiceringsprocessen dem. Beroende på vilket team som hanterar lagringsplatsen som du bidrar till kan publiceringstiderna variera, men de inträffar vanligtvis minst en gång varje veckodag. Det kan ta upp till 45 minuter innan artiklar syns online efter publicering.

När dina ändringar har publicerats går de live på Microsoft Learn så att andra kan börja lära sig från!

Scenario: Publicera ändringar i Azure App Service