Přehled příručky pro přispěvatele na Microsoft Learn

Vítejte v příručce pro přispěvatele na Microsoft Learn!

Sdílení odborných znalostí s ostatními na Microsoft Learn pomáhá všem dosahovat vyšších výsledků. Informace v tomto průvodci slouží k publikování nového článku na webu Microsoft Learn nebo aktualizaci existujícího publikovaného článku.

Některé sady dokumentace Microsoftu jsou dostupné jako Open Source a hostují se na GitHubu. Ne všechny sady dokumentů jsou zcela open source, ale mnoho z nich má veřejně přístupná úložiště, kde můžete navrhovat změny prostřednictvím žádostí o přijetí změn. Tento opensourcový přístup zjednodušuje a zlepšuje komunikaci mezi produktovými inženýry, týmy pro obsah a zákazníky a má i další výhody:

• otevřené plánování , abyste získali zpětnou vazbu k tomu, které dokumenty a vylepšení jsou nejpotřebnější
• otevřené revize , aby bylo dosaženo užitečného komunitního hodnocení materiálů
• aktualizace v otevřeném okně , aby bylo snazší průběžně vylepšovat obsah

Začněte přispívat úpravou dokumentu, který si prohlížíte. Nebo vám můžete pomoct s prohlížením nových témat nebo vytvářením problémů s kvalitou.

Důležité

Všechna úložiště, která publikují na Microsoft Learn, přijala pravidla chování pro Microsoft Open Source nebo pravidla chování pro .NET Foundation. Další informace najdete v častých otázkách k pravidlům chování. Obraťte se na opencode@microsoft.com nebo conduct@dotnetfoundation.org se svými dotazy nebo připomínkami.

Na menší opravy nebo vysvětlení dokumentace a příklady kódu ve veřejných úložištích se vztahují learn.microsoft.com podmínky použití. Nové nebo významné změny vygenerují v žádosti o přijetí změn komentář, který vás požádá o odeslání online licenční smlouvy s přispěvatelem (CLA), pokud nejste zaměstnancem Microsoftu. Než budeme moct vaši žádost o přijetí změn zkontrolovat nebo přijmout, musíte vyplnit online formulář.

Rychlé úpravy dokumentace

Rychlé úpravy zjednodušují proces hlášení a oprav malých chyb a vynechání v dokumentaci. I přes veškeré úsilí můžou v našich publikovaných dokumentech zůstat drobné gramatické a pravopisné chyby. I když můžete vytvářet problémy a oznamovat chyby, je rychlejší a jednodušší vytvořit žádost o přijetí změn k vyřešení problému, když je k dispozici tato možnost.

1. K přispívání potřebujete účet GitHub. Pokud už účet máte, ujistěte se, že jste přihlášeni. Pokud nemáte účet GitHub, přejděte na https://github.com/join adresu a proveďte rychlý a bezplatný proces registrace.

2. Přejděte do dokumentace, kterou chcete upravit. Na některých stránkách dokumentace můžete upravovat obsah přímo v prohlížeči. Pokud ano, zobrazí se ikona tužky Pro úpravy , která je podobná té, která je zobrazená níže. Výběrem ikony tužky Upravit přejdete ke zdrojovému souboru na GitHubu.

   

   Pokud tlačítko Upravit není k dispozici, znamená to, že obsah není otevřený pro veřejné příspěvky. Některé stránky jsou generovány (například z vložené dokumentace v kódu) a musí být upraveny v projektu, do který patří.

3. Vyberte ikonu tužky v horní části stránky souboru GitHubu. Pokud je ikona tužky zašedlá nebo se nezobrazuje, musíte se přihlásit ke svému účtu GitHub.

   

   V horní části článku jsou metadata článku. Metadata se používají na články pro vytváření sestav, zjistitelnost prostřednictvím vyhledávání a řízení aspektů prostředí webu. Pokud provádíte menší aktualizace publikovaného článku, pravděpodobně nebudete muset měnit metadata.

4. Pokud v tomto úložišti pracujete poprvé, zobrazí se před návrhem změn výzva k vytvoření forku úložiště. Pokračujte výběrem možnosti Fork this repository (Vytvořit fork tohoto úložiště ).

5. Upravte soubor ve webovém editoru. Na panelu nástrojů zvolte kartu Náhled a zkontrolujte formátování změn.

6. Po dokončení úprav vyberte tlačítko Potvrdit změny nebo Navrhnout změny , obvykle v pravém horním rohu obrazovky.

7. Zadejte zprávu potvrzení. Potvrzovací zpráva se stane názvem vaší žádosti o přijetí změn a měla by obsahovat stručný souhrn změn (například Oprava pravopisných a gramatických chyb). Volitelně můžete přidat rozšířený popis , který vám poskytne další podrobnosti o změnách. Vyberte Navrhnout změny:

   

8. Teď, když jste navrhli a potvrdili své změny, musíte požádat vlastníky úložiště, aby změny "stáhli" do svého úložiště. K tomu se používá žádost o přijetí změn(PR). Když vyberete Navrhnout změny, zobrazí se stránka podobná této:

   

   Vyberte porovnat napříč forky a ujistěte se, že konfigurace vaší větve vypadá jako výše uvedená. Žádost o přijetí změn by měla navrhnout změny z forku a větve (reprezentované dvěma položkami na pravé straně šipky) do forku a main větve úložiště MicrosoftDocs (reprezentované dvěma položkami na levé straně šipky). Možná budete muset vybrat rozevírací pole a upravit názvy úložiště a větví.

   Zkontrolujte provedené změny a pak vyberte Vytvořit žádost o přijetí změn.

9. Na stránce Otevřít žádost o přijetí změn zobrazte náhled žádosti o přijetí změn. Pole názvu nebo popisu můžete v případě potřeby změnit. Až budete připraveni, vyberte Vytvořit žádost o přijetí změn. Tato akce otevře vaši žádost o přijetí změn.

10. Pokud všechno vypadá dobře a dokončili jste úpravy, přidejte komentář s textem #sign-off. Tím tým pro kontrolu žádostí o přijetí změn upozorní, že vaše žádost o přijetí změn je připravená ke kontrole.

    

11. A to je vše! Členové týmu obsahu vaši žádost o přijetí změn zkontrolují a po schválení ji sloučí. Můžete získat zpětnou vazbu s žádostí o změny.

Uživatelské rozhraní GitHubu pro úpravy se přizpůsobuje podle oprávnění uživatele v daném úložišti. Předchozí image jsou určené pro přispěvatele, kteří nemají oprávnění k zápisu do cílového úložiště. GitHub automaticky vytvoří ve vašem účtu fork cílového úložiště. Název nově vytvořeného forku má ve výchozím nastavení formulář GitHubUsername/RepositoryName . Pokud máte oprávnění k zápisu do cílového úložiště, například k vašemu forku, GitHub v cílovém úložišti vytvoří novou větev. Název větve má výchozí formát patch-n, který používá číselný identifikátor pro větev opravy.

Žádosti o přijetí změn používáme pro všechny změny, a to i pro přispěvatele s oprávněním k zápisu. Většina úložišť chrání výchozí větev, takže aktualizace se musí odesílat jako žádosti o přijetí změn.

Prostředí pro úpravy v prohlížeči je nejvhodnější pro drobné nebo málo časté změny. Pokud provádíte velké příspěvky nebo používáte pokročilé funkce Git (třeba správu větví nebo pokročilé řešení konfliktů při sloučení), potřebujete vytvořit fork úložiště a pracovat místně.

Poznámka

Většina lokalizovaných dokumentů nenabízí možnost upravovat ani poskytovat zpětnou vazbu prostřednictvím GitHubu. Pokud chcete poskytnout zpětnou vazbu k lokalizovaného obsahu, použijte https://aka.ms/provide-feedback formulář.

Kontrola otevřených žádostí o přijetí změn na GitHubu

Před publikováním si můžete přečíst nová témata tak, že zkontrolujete otevřenou frontu žádostí o přijetí změn na GitHubu. Revize se řídí procesem toku GitHubu. Ve veřejných úložištích můžete vidět navrhované aktualizace a nové články. Seznamte se s nimi a přidejte svoje komentáře. Podívejte se na některé z našich úložišť Microsoft Learn a podívejte se na otevřené žádosti o přijetí změn v oblastech, které vás zajímají. Zpětná vazba komunity na navrhované aktualizace pomáhá celé komunitě.

Problémy s vytvářením GitHubu

Naše dokumenty jsou výsledkem nepřetržitě probíhající práce. Dobré problémy na GitHubu nám pomáhají zaměřit naše úsilí na nejvyšší priority komunity. Čím více podrobností zadáte, tím je položka problému užitečnější. Sdělte nám, co jste hledali. Sdělte nám, jaké termíny jste při hledání použili. Pokud nemůžete zahájit práci, sdělte nám, jak se chcete s neznámou technologií začít seznamovat.

Na mnoha stránkách dokumentace microsoftu je v dolní části stránky oddíl Váš názor , kde můžete zanechat zpětnou vazbu k produktu (odkaz na tento produkt ) nebo zpětnou vazbu k obsahu (odkaz na tuto stránku ), abyste mohli sledovat problémy specifické pro daný článek. Obě tyto možnosti vyžadují, abyste se přihlásili ke GitHubu nebo jinému systému. Pokud chcete zanechat anonymní zpětnou vazbu, použijte ikonu palec nahoru k zpětné vazbě , která se zobrazí v pravém horním rohu každého článku pod nadpisem.

Položky problémů umožňují zahájit konverzaci o tom, co je potřeba udělat. Obsahový tým bude na tyto problémy reagovat nápady, co můžeme přidat, a požádat o vaše názory. Až vytvoříme koncept, požádáme vás o revizi dané žádosti o přijetí změn.

Zapojte se více

Další témata v této příručce vám pomůžou začít produktivně přispívat do Microsoft Learn. Vysvětlují práci s úložišti GitHubu, nástroji Markdownu a rozšířeními používanými v obsahu Microsoft Learn.