Så här lämnar du in 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 läsa den redaktionella checklistan 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 sammanfogas till grenen live varje veckodag kl. 15:00 (Pacific Time). Grenen live innehåller det innehåll som publiceras till learn.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 up-to-date-kopia av grenen main .

Alla pull-begäranden ska riktas mot grenen main . Skicka inte ändringar till grenen live . Ändringar som görs i grenen main sammanfogas i liveoch skriver över eventuella ändringar som gjorts i live.

Få pull-begärandeprocessen 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. Separera mindre uppdateringar av befintliga artiklar från nya artiklar eller större omskrivningar. Arbeta med dessa ändringar i separata arbetsgrenar.

Massändringar skapar PR:er med ett stort antal ändrade filer. Begränsa dina PR:er till högst 50 ändrade filer. Stora PR:er är svåra att granska och är mer benägna att innehålla fel.

Byta namn på eller ta bort filer

Det måste finnas ett problem som är kopplat till PR när du byter namn på eller tar bort filer. Det här problemet måste diskutera behovet av att byta namn på eller ta bort filerna.

Undvik att blanda innehållstillägg eller ändringar med filbyten och borttagningar. Alla filer som du byter namn på eller tar bort måste läggas till i lämplig omdirigeringsfil. 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.

Undvik att redigera lagringsplatsens konfigurationsfiler

Undvik att ändra lagringsplatsens konfigurationsfiler. Begränsa ändringarna där det är möjligt till Markdown-innehållsfilerna och eventuella stödbildfiler som behövs för innehållet.

Felaktiga ändringar av lagringsplatsens konfigurationsfiler kan bryta mot bygget, medföra sårbarheter eller tillgänglighetsproblem eller bryta mot organisationens standarder. Lagringsplatsens konfigurationsfiler är filer som matchar ett eller flera av dessa mönster:

• *.yml
• .github/**
• .localization-config
• .openpublishing*
• LICENSE*
• reference/docfx.json
• reference/mapping/**
• tests/**
• ThirdPartyNotices
• tools/**

För säkerhets skull, ändra inte dessa filer. Om du tycker att en av dessa filer bör ändras kan du rapportera ett problem. När underhållspersonalen har prioriterat problemet, kommer de att göra nödvändiga ändringar.

Använda PR-mallen

När du skapar en PR infogas en mall automatiskt i PR-beskrivningen åt dig. Det ser ut så här:

# PR Summary

<!--
    Delete this comment block and summarize your changes and list
    related issues here. For example:

    This changes fixes problem X in the documentation for Y.

    - Fixes #1234
    - Resolves #1235
-->

## PR Checklist

<!--
    These items are mandatory. For your PR to be reviewed and merged,
    ensure you have followed these steps. As you complete the steps,
    check each box by replacing the space between the brackets with an
    x or by clicking on the box in the UI after your PR is submitted.
-->

- [ ] **Descriptive Title:** This PR's title is a synopsis of the changes it proposes.
- [ ] **Summary:** This PR's summary describes the scope and intent of the change.
- [ ] **Contributor's Guide:** I have read the [contributors guide][contrib].
- [ ] **Style:** This PR adheres to the [style guide][style].

<!--
    If your PR is a work in progress, please mark it as a draft or
    prefix it with "(WIP)" or "WIP:"

    This helps us understand whether or not your PR is ready to review.
-->

[contrib]: /powershell/scripting/community/contributing/overview
[style]: /powershell/scripting/community/contributing/powershell-style-guide

I avsnittet "PR-sammanfattning" skriver du en kort sammanfattning av dina ändringar och listar eventuella relaterade problem med deras ärendenummer, till exempel #1234. Om din pr åtgärdar eller löser problemet använder du GitHubs autoclose-funktion så att problemet stängs automatiskt när din pr slås samman.

Granska objekten i avsnittet "PR Checklista" och markera dem när du slutför var och en. Du måste följa anvisningarna och kontrollera varje objekt för att teamet ska godkänna din PR.

Om din PR är ett pågående arbete ställer du in den på utkastläge eller prefixar pr-titeln med WIP.

Kommentar om förväntningar

När du har skickat din PR kommenterar en robot din PR. Kommentaren innehåller resurser och anger förväntningar för resten av processen. Vi kan uppdatera den här kommentaren regelbundet, så granska alltid kommentaren, även om det inte är ditt första bidrag.

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 steg beskriver verifieringsbeteendet:

1. Du skickar en PR.

2. I GitHub-kommentaren som anger status för de "granskningar" som är aktiverade i kodförrådet. I det här exemplet har två kontroller aktiverats, "Commit Validation" och "OpenPublishing.Build":

   

   Bygget kan gå igenom även om commit-verifieringen misslyckas.

3. Välj Information för mer information. Sidan Information visar alla valideringskontroller som misslyckades och innehåller information om hur du åtgärdar problemen.

4. När valideringen lyckas läggs följande kommentar till i PR:

   

Anmärkning

Om du är en extern deltagare (inte en Microsoft-anställd) har du inte åtkomst till de detaljerade byggrapporterna eller förhandsgranskningslänkarna.

När pr-begäran 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.

GitHub Actions (verktyg för arbetsflöden)

Flera olika GitHub Actions körs mot dina ändringar för att verifiera och tillhandahålla kontext för dig och granskarna.

Verifiering av checklista

Om din PR inte är i utkastläge och inte är prefixat med WIP, granskar en GitHub Action din PR för att säkerställa att du har markerat varje objekt i PR-mallens checklista. Förvaltarna kommer inte att granska eller sammanfoga din PR förrän du har slutfört checklistan. Checklistans objekt är obligatoriska.

Verifiering av auktorisering

Om din PR riktar sig mot grenen live eller ändrar några lagringsplatskonfigurationsfiler kontrollerar en GitHub-åtgärd dina behörigheter för att kontrollera att du har behörighet att skicka ändringarna.

Endast lagringsplatsadministratörer har behörighet att rikta in sig på grenen live eller ändra lagringsplatsens konfigurationsfiler.

Versionsrapportering för innehållsändringar

Om din PR lägger till, tar bort eller ändrar versionsinnehåll analyserar en GitHub-åtgärd dina ändringar och skriver en rapport som sammanfattar de typer av ändringar som görs i versionsinnehåll.

Den här rapporten kan visa om det finns andra versioner av filerna som du behöver uppdatera i denna PR.

Hitta den versionerade innehållsrapporten för din PR:

1. Välj fliken "Kontroller" på pr-sidan.
2. Välj jobbet "Rapportering" i listan över jobb.
3. Välj "..." längst upp till höger.
4. Välj "Visa jobbsammanfattning".

Nästa steg

PowerShell-Docs stilguide

Ytterligare resurser

Så hanterar vi pull-begäranden