Hantera pull-begäranden

  • Artikel

Den här artikeln beskriver hur vi hanterar pull-begäranden på PowerShell-Docs lagringsplatsen. Den här artikeln är utformad för att vara ett jobbstöd för medlemmar i PowerShell-Docs-teamet. Den publiceras här för att ge processtransparens för våra offentliga deltagare.

Bästa praxis

  • Den person som skickar pull-begäran bör inte sammanslå pull-begäran utan peer-granskning.
  • Tilldela peer-granskaren när pull-begäran skickas. Tidig tilldelning gör det möjligt för granskaren att svara tidigare med redaktionella kommentarer.
  • Använd kommentarer för att beskriva typen av ändring eller vilken typ av granskning som begärs. Se till att @mention granskaren. Om ändringen till exempel är mindre och du inte behöver en fullständig teknisk granskning kan du förklara detta i en kommentar.

Pr-processsteg

  1. Författare: Skapa pull-begäran
    • Länka eventuella problem som lösts av pull-begäran
    • Använd GitHub autoclose-funktion för att stänga problemet
  2. Skrivare: Tilldela peer-granskare
  3. Granskare: korrekturläsningar och kommentarer (efter behov)
  4. Författare: Inkludera feedback om granskning
  5. Båda: Granska förhandsgranskningsrendering
  6. Båda: Granska valideringsrapporten – åtgärda varningar och fel
  7. Författare: Lägg till signeringskommentare (inkludera Acrolinx-information)
  8. Granskare: Markera recensionen "Godkänd"
  9. Lagringsplatsadministratör: Sammanslå PR (se nedan för kriterier)

Checklista för innehållsgranskare

En mer omfattande lista finns i checklistan för ledare .

  • Korrekturläsning för grammatik, stil, koncision, teknisk noggrannhet
  • Se till att exemplen fortfarande gäller för målversionen
  • Kontrollera förhandsgranskningsrendering
  • Kontrollera metadata – ms.date, ta bort ms.assetid, kontrollera obligatoriska fält
  • Verifiera markdown-korrekthet
    • Se formatguiden för innehållsspecifika formateringsregler
  • Ordna om exempel på följande sätt:
    • Introduktions meningar
    • Kod och utdata
    • Detaljerad förklaring av kod (vid behov)
  • Kontrollera att hyperlänkar är korrekta
    • Ersätta eller ta bort TechNet/MSDN-länkar
    • Se till att det minsta antalet omdirigeringar till målet
    • Kontrollera HTTPS
    • Rätt länktyp
      • Fillänkar för lokala filer
      • URL-länkar för filer utanför dokumentuppsättningen
    • Ta bort nationella inställningar från URL:er
    • Förenkla URL:er som pekar på docs.microsoft.com

Sammanslagningsprocess för gren

Grenen main är den enda grenen som sammanfogas till live. Sammanslagningar från kortlivade (fungerande) grenar ska krossas.

Sammanfoga från/till release-branch main Live
working-branch squash och sammanslagning squash och sammanslagning Inte tillåten
release-branch — merge Inte tillåten
main Rebase — merge

Checklista för PR-sammanslagning

  • Innehållsgranskningen har slutförts
  • Rätt målgren för ändringen
  • Inga sammanslagningskonflikter
  • Alla verifierings- och byggstegspass
    • Varningar och förslag bör åtgärdas (se Anteckningar för undantag)
    • Inga brutna länkar
  • Sammanfoga enligt tabell

Kommentarer

Följande varningar kan ignoreras:

Can't find service name for `<version>/<modulepath>/About/About.md`

Metadata with following name(s) are not allowed to be set in Yaml header, or as file level
metadata in docfx.json, or as global metadata in docfx.json: `locale`. They are generated by
Docs platform, so the values set in these 3 places will be ignored. Please remove them from all
3 places to resolve the warning.

När en pull-begäran slås samman ändras huvudnamnet för målgrenen. Alla öppna PR som baserades på föregående HEAD är nu inaktuella. Den inaktuella pull-begäran kan sammanfogas med administratörsbehörighet för att åsidosätta sammanslagningsvarningarna i GitHub. Det här är säkert om de tidigare sammanfogade pull-begärandena inte har rört samma filer. Det säkraste alternativet är dock att klicka på knappen Uppdatera gren . Du kan ha olösta konflikter som måste åtgärdas.

Publicera till live

Med jämna mellanrum måste de ändringar som ackumuleras i grenen main publiceras på livewebbplatsen.

  • Grenen main slås samman till live varje veckodag kl. 15.00 PST.
  • Grenen main ska sammanfogas till live efter en betydande ändring.
    • Ändringar i 50 eller fler filer
    • När du har sammanfogat en versionsgren
    • Ändringar i lagringsplatsen eller docset-konfigurationer (docfx.json, OPS-konfigurationer, byggskript osv.)
    • Ändringar i omdirigeringsfilen
    • Ändringar i toc
    • Efter sammanslagning av en "projekt"-gren (innehållsreorg, massuppdatering osv.)