Skicka pull-begäranden
Om du vill göra ändringar i innehållet skickar du en pull-begäran (PR) från din förgrening. En pull-begäran måste granskas innan den kan sammanfogas. För bästa resultat kan du granska checklistan för ledare innan du skickar din pull-begäran.
Använda git-grenar
Standardgrenen för PowerShell-Docs är grenen main . Ändringar som görs i arbetsgrenar sammanfogas i grenen main innan de publiceras. Grenen main slås samman i grenen live varje veckodag kl. 15:00 (Pacific Time). Grenen live innehåller det innehåll som publiceras till docs.microsoft.com.
Innan du påbörjar några ändringar skapar du en arbetsgren i din lokala kopia av PowerShell-Docs-lagringsplatsen. När du arbetar lokalt måste du synkronisera den lokala lagringsplatsen innan du skapar din arbetsgren. Arbetsgrenen ska skapas från en uppdaterad kopia av grenen main .
Alla pull-begäranden bör riktas mot grenen main . Skicka inte ändringar till grenen live . Ändringar som görs i grenen main sammanfogas i liveoch skriver över ändringar som gjorts livei .
Få pull-begäran att fungera bättre för alla
Ju enklare och mer fokuserad du kan göra din PR, desto snabbare kan den granskas och sammanfogas.
Undvik pull-begäranden som uppdaterar ett stort antal filer eller innehåller orelaterade ändringar
Undvik att skapa PR:er som innehåller orelaterade ändringar. Olika små uppdateringar i befintliga artiklar från nya artiklar eller större omskrivningar. Arbeta på dessa ändringar i olika arbetsflöden.
Massändringar skapar pr med ett stort antal ändrade filer. Begränsa din pull-begäran till högst 50 ändrade filer. Stora pull-begäranden är svåra att granska och är mer benägna att innehålla fel.
Byta namn på eller ta bort filer
När du byter namn på eller tar bort filer måste det finnas ett problem som är kopplat till PR. Det här problemet måste diskutera behovet av att byta namn på eller ta bort filerna.
Undvik att blanda innehållstillägg eller ändra med filbyten och borttagningar. Alla filer som har bytt namn eller tagits bort måste läggas till i den globala omdirigeringsfilen. När det är möjligt uppdaterar du alla filer som länkar till det omdöpta eller borttagna innehållet, inklusive alla INNEHÅLLSFÖRTECKNINGsfiler.
Docs PR-valideringstjänst
Docs PR-valideringstjänsten är en GitHub app som kör valideringsregler för dina ändringar. Du måste åtgärda eventuella fel eller varningar som rapporteras av valideringstjänsten.
Följande beteende kommer att visas:
Du skickar en PR.
I den GitHub kommentaren som anger status för din pr visas statusen "kontroller" aktiverad på lagringsplatsen. I det här exemplet är två kontroller aktiverade, "Commit Validation" och "OpenPublishing.Build":
Bygget kan passera även om incheckningsverifieringen misslyckas.
Klicka på Details (Detaljerad information) om du vill ha mer information.
På sidan Details (Detaljerad information) visas alla valideringskontroller som har misslyckats och information om hur du åtgärdar problemen.
När verifieringen lyckas läggs följande kommentar till i pull-begäran:
Anteckning
Om du är en extern deltagare (inte en Microsoft-anställd) har du inte åtkomst till de detaljerade kompileringsrapporterna eller förhandsgranskningslänkarna.
När PR granskas kan du bli ombedd att göra ändringar eller åtgärda valideringsvarningsmeddelanden. PowerShell-Docs-teamet kan hjälpa dig att förstå valideringsfel och redaktionella krav.
Nästa steg
Ytterligare resurser
Feedback
Skicka och visa feedback för