Odeslání žádostí o přijetí změn

Pokud chcete provést změny obsahu, odešlete žádost o přijetí změn (PR) z vašeho forku. Žádost o přijetí změn musí být před sloučením zkontrolována. Pokud chcete dosáhnout nejlepších výsledků, před odesláním žádosti o přijetí změn si prohlédněte redakční kontrolní seznam .

Použití větví Gitu

Výchozí větev pro PowerShell-Docs je main větev. Změny provedené v pracovních větvích se před publikováním sloučí do main větve. main Větev se sloučí do live větve každý pracovní den v 3:00 (Tichomoří). Větev live obsahuje obsah publikovaný do docs.microsoft.com.

Před zahájením jakýchkoli změn vytvořte pracovní větev v místní kopii úložiště PowerShell-Docs. Při práci místně nezapomeňte před vytvořením pracovní větve synchronizovat místní úložiště. Pracovní větev by se měla vytvořit z kopie větve main update-to-date.

Všechny žádosti o přijetí změn by měly cílit na main větev. Neodesílejte změnu do live větve. Změny provedené ve main větvi se sloučí do live, přepíše všechny změny provedené v live.

Lepší fungování procesu žádosti o přijetí změn pro všechny

Jednodušší a více zaměřené, můžete vytvořit žádost o přijetí změn, tím rychleji ji můžete zkontrolovat a sloučit.

Vyhněte se žádostem o přijetí změn, které aktualizují velký počet souborů nebo obsahují nesouvisející změny.

Vyhněte se vytváření žádostí o přijetí změn, které obsahují nesouvisející změny. Oddělte menší aktualizace stávajících článků od nových článků nebo výrazných přepracování. Na těchto změnách pracujte v samostatných pracovních větvích.

Hromadné změny vytvářejí žádosti o přijetí změn s velkým počtem změněných souborů. Omezte své žádosti o přijetí změn na nejvýše 50 změněných souborů. Rozsáhlé žádosti o přijetí změn se obtížně kontrolují a je u nich větší pravděpodobnost výskytu chyb.

Přejmenovávání nebo odstraňování souborů

Při přejmenování nebo odstraňování souborů musí dojít k problému přidruženému k žádosti o přijetí změn. Tento problém musí prodiskutovat potřebu přejmenovat nebo odstranit soubory.

Vyhněte se kombinování doplňků obsahu nebo změně s přejmenováním a odstraněním souborů. Každý soubor, který je přejmenován nebo odstraněn, musí být přidán do globálního souboru přesměrování. Pokud je to možné, aktualizujte všechny soubory, které odkazují na přejmenovaný nebo odstraněný obsah, včetně všech souborů obsahu.

Odkaz na službu ověřování žádostí o přijetí změn Docs

Ověřovací služba žádosti o přijetí změn docs je GitHub aplikace, která ve vašich změnách spouští ověřovací pravidla. Všechny chyby nebo upozornění hlášené ověřovací službou je nutné opravit.

Uvidíte následující chování:

  1. Odešlete žádost o přijetí změn.

  2. V GitHub komentáři, který označuje stav žádosti o přijetí změn, uvidíte stav kontrol povolených v úložišti. V tomto příkladu jsou povolené dvě kontroly, ověření potvrzení a OpenPublishing.Build:

    stav ověření – některé kontroly selhaly

    Sestavení může předat i v případě, že se ověření potvrzení nezdaří.

  3. Další informace se zobrazí po kliknutí na Details (Podrobnosti).

  4. Na stránce podrobností se zobrazí všechny neúspěšné validační kontroly, včetně informací o možném řešení problémů.

  5. Pokud je ověření úspěšné, přidá se do žádosti o přijetí změn následující komentář:

    Stav ověření: úspěch

Poznámka

Pokud jste externím přispěvatelem (ne zaměstnancem Microsoftu), nemáte přístup k podrobným sestavám sestavení nebo odkazům na náhled.

Po kontrole žádosti o přijetí změn můžete být požádáni, abyste provedli změny nebo opravili zprávy upozornění ověření. Tým PowerShell-Docs vám pomůže porozumět chybám ověření a redakčním požadavkům.

Další kroky

PowerShell – průvodce stylem dokumentace

Další materiály

Jak spravujeme žádosti o přijetí změn