Dela via

Hantera pull-begäranden

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. Vi publicerar den här informationen här för att ge processtransparens för våra offentliga deltagare.

Metodtips

  • Begär en granskning. Den person som skickar pr-begäran bör inte slå samman pr-begäran utan en peer-granskning.
  • Tilldela peer-granskaren när PR skickas. Med tidig tilldelning kan granskaren svara tidigare med redaktionella kommentarer.
  • Använd kommentarer för att beskriva typen av ändring som skickas. Om ändringen till exempel är mindre förklarar du ändringen och att du inte behöver en fullständig teknisk granskning. Var noga med att @mention granskaren.
  • Använd kommentarsförslagsfunktionen för att göra det enklare för författaren att acceptera den föreslagna ändringen. Mer information finns i Granska föreslagna ändringar i en pull-begäran.

PR-processsteg

  1. Skrivare: Skapa PR
    • Fyll i PR-mallen
    • Länka eventuella problem som löses av PR
    • Stäng problemet med hjälp av GitHubs autoclose-funktion
    • Gå igenom och checka av varje objekt i checklistan
  2. Författare: Tilldela kollegial granskare
  3. Granskare: korrekturläsningar och kommentarer (efter behov)
  4. Författare: Införliva feedback från granskning
  5. Båda: Kontrollera förhandsvisning
  6. Båda: Granska valideringsrapport – åtgärda varningar och fel
  7. Granskare: Markera recensionen "Godkänd"
  8. Lagringsplatsunderhållare: Slå samman PR

Checklista för innehållsgranskare

Se den redaktionella checklistan för en mer omfattande lista.

  • Korrekturläsning för grammatik, stil, koncision, teknisk noggrannhet
  • Se till att exempel fortfarande gäller för målversionen
  • Kontrollera återgivning av förhandsversion
  • Kontrollera metadata – ms.date, ta bort ms.assetid, se till att de obligatoriska fälten finns
  • Verifiera markdown-korrekthet
    • Se formatguide för innehållsspecifika formateringsregler
  • Omorganisera exempel på följande sätt:
    • Introduktionsstycke
    • Kod och utdata
    • Detaljerad förklaring av kod (efter behov)
  • Kontrollera att hyperlänkar är korrekta
    • Ersätta eller ta bort TechNet/MSDN-länkar
    • Se till att minimera antalet omdirigeringar som är till målet
    • Säkerställ 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å learn.microsoft.com
  • Kontrollera att versionsinnehållet är korrekt i alla versioner

Sammanslagningsprocess för gren

Grenen main är den enda gren som ska sammanfogas till live. Sammanslagningar från kortlivade grenar (arbetsgrenar) ska krossas innan de sammanfogas till main.

Sammanfoga från/till release-branch huvudsaklig direktsänd
arbetsgren squash och sammanslagning squash och sammanslagning Tillåts inte
release-branch — sammanfoga Tillåts inte
huvudsaklig Rebase — sammanfoga

Checklista för PR-sammanslagning

  • Innehållsgranskningen är klar
  • Rätt målgren för ändringen
  • Inga sammanslagningskonflikter
  • Alla validerings- och byggstegspass
  • Sammanfoga enligt tabell

Noteringar

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 PR slås samman ändras head för målgrenen. Alla öppna PR:er som baserades på föregående HEAD är nu inaktuella. En maintainer har rättigheterna som krävs för att åsidosätta sammanslagningsvarningarna och slå samman den inaktuella PR:n i GitHub. Det är säkert att slå samman en inaktuell PR om de tidigare sammanfogade PR:erna inte rörde samma filer.

Om du vill uppdatera PR väljer du knappen Uppdatera gren . Välj Alternativet Uppdatera med ombasering . Mer information finns i Uppdatering av din pull request-gren.

Publicera direkt

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

  • Grenen main sammanfogas till live varje veckodag kl. 15.00 PST.
  • Grenen main ska sammanfogas till live efter en betydande ändring.
    • Ändringar i 50 eller fler filer
    • Efter sammanslagning av en versionsgren
    • Ändringar i lagringsplats- eller dokumentuppsättningskonfigurationer (docfx.json, OPS-konfigurationer, byggskript osv.)
    • Ändringar i omdirigeringsfilen
    • Ändringar i Innehållsförteckningen
    • När du har sammanfogat en "projektgren" (innehållsreorganisering, storskalig uppdatering, osv.)
  • Last updated on