Průvodce pro přispěvatele na web Microsoft Docs – přehledMicrosoft Docs contributor guide overview

Vítá vás Průvodce pro přispěvatele na webu docs.microsoft.com (Docs)!Welcome to the docs.microsoft.com (Docs) Contributor Guide!

Některé sady dokumentace Microsoftu jsou dostupné jako Open Source a hostují se na GitHubu.Several of the Microsoft documentation sets are open source and hosted on GitHub. Všechny sady dokumentace nejsou plně dostupné jako Open Source, ale řada z nich má veřejná úložiště, ve kterých můžete provádět navrhované změny prostřednictvím žádostí o přijetí změn.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. Opensourcový přístup zjednodušuje a zlepšuje komunikaci mezi produktovými techniky, týmy vytvářejícími obsah a zákazníky, ale má i další výhody:This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • Plánování úložišť Open Source se provádí otevřeně, což umožňuje získávat zpětnou vazbu o tom, které dokumenty jsou nejvíce žádané.Open source repos plan in the open to get feedback on what docs are most needed.
  • Revize úložišť Open Source se provádějí otevřeně, takže je možné v naší nové verzi publikovat nejužitečnější obsah.Open source repos review in the open to publish the most helpful content on our first release.
  • Aktualizace úložišť Open Source se provádějí otevřeně, takže jde snadněji průběžně vylepšovat obsah.Open source repos update in the open to make it easier to continuously improve the content.

Aby to bylo ještě jednodušší, uživatelské prostředí na webu docs.microsoft.com přímo integruje pracovní postupy GitHubu.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. Můžete začít úpravami dokumentu, který si prohlížíte.Start by editing the document you are viewing. Případně můžete pomoct s revizemi nových témat nebo s vytvářením užitečných položek problémů.Or, help by reviewing new topics, or create quality issues.

Důležité

Všechna úložiště, která se publikují na docs.microsoft.com, přijala pravidla chování pro Microsoft Open Source nebo pravidla chování pro .NET Foundation.All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. Další informace najdete v častých otázkách k pravidlům chování.For more information, see the Code of Conduct FAQ. Se svými dotazy nebo připomínkami se můžete také obrátit na opencode@microsoft.com nebo conduct@dotnetfoundation.org.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

Na menší opravy nebo vysvětlení k dokumentaci a ukázkám kódu ve veřejných úložištích se vztahují podmínky použití pro docs.microsoft.com.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. Nové nebo výrazné změny vygenerují v žádosti o přijetí změn komentář, abyste odeslali online licenční smlouvu s přispěvatelem (CLA), pokud nejste zaměstnancem Microsoftu.New or significant changes generate a comment in the pull request, asking you to submit an online Contribution License Agreement (CLA) if you are not an employee of Microsoft. Potřebujeme, abyste tento online formulář vyplnili. Teprve pak vaši žádost o přijetí změn můžeme revidovat a přijmout.We need you to complete the online form before we can review or accept your pull request.

Rychlé úpravy existujících dokumentůQuick edits to existing documents

Rychlé úpravy zjednodušují proces oznamování a oprav drobných chyb a vynechávek v dokumentech.Quick edits streamline the process to report and fix small errors and omissions in documents. I přes veškeré úsilí můžou v našich publikovaných dokumentech zůstat drobné gramatické a pravopisné chyby.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Je sice možné oznamovat tyto chyby tak, že vytvoříte položky problémů, když ale vytvoříte žádost o přijetí změn (pokud je tato možnost dostupná), bude jejich oprava rychlejší a jednodušší.While you can create issues to report mistakes, it's faster and easier to create a pull request (PR) to fix the issue, when the option is available.

  1. Na některých stránkách dokumentace můžete upravovat obsah přímo v prohlížeči.Some docs pages allow you to edit content directly in the browser. V takovém případě se na stránce zobrazí tlačítko Edit (Upravit), jak vidíte níže.If so, you'll see an Edit button like the one shown below. Kliknutím na tlačítko Edit (Upravit) se dostanete na zdrojový soubor na GitHubu.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. Pokud tlačítko Edit nevidíte, znamená to, že stránku dokumentace nelze měnit.If the Edit button is missing, that means the documentation page is not available to be changed.

    Umístění odkazu pro úpravy

  2. Pak klikněte na ikonu tužky, abyste mohli článek upravit.Next, click the pencil icon, to edit the article as shown. Pokud je ikona tužky šedá, je nutné, abyste se přihlásili ke svému účtu GitHub nebo abyste si vytvořili nový účet.If the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

    Umístění ikony tužky

  3. Proveďte příslušné změny ve webovém editoru.Make your changes in the web editor. Klikněte na kartu Preview changes (Náhled změn) a zkontrolujte formátování jednotlivých změn.Click the Preview changes tab to check the formatting of your change.

  4. Po provedení změn se posuňte do dolní části stránky.Once you have made your changes, scroll to the bottom of the page. Zadejte název a popis svých změn a klikněte na tlačítko Propose file change (Navrhnout změnu souboru), jak je vidět na následujícím obrázku:Enter a title and description for your changes and click Propose file change as shown in the following figure:

    Návrh změny souboru

  5. Teď, když jste navrhli změnu, musíte požádat vlastníky úložiště, aby vaši změnu „přijali“ do svého úložiště.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. K tomu slouží takzvaná „žádost o přijetí změn“.This is done using something called a "pull request". Když jste kliknuli na Propose file change (Navrhnout změnu souboru) v obrázku výše, měli byste se dostat na novou stránku, která vypadá jako na následujícím obrázku:When you clicked on Propose file change in the figure above, you should have been taken to a new page that looks like the following figure:

    vytvoření žádosti o přijetí změn

    Klikněte na Create pull request (Vytvořit žádost o přijetí změn), zadejte název (a volitelně popis) této žádosti o přijetí změn a pak znovu klikněte na Create pull request.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (Pokud s GitHubem teprve začínáte, můžete si přečíst další informace v článku o žádostech o přijetí změn.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. A to je vše!That's it! Členové týmu pro obsah provedou revizi a sloučení vaší žádosti o přijetí změn.Content team members will review and merge your PR. Pokud jste provedli větší změny, je možné, že dostanete zpětnou vazbu vyžadující nějaké změny.You may get some feedback requesting changes if you made larger changes.

Uživatelské rozhraní GitHubu pro úpravy se přizpůsobuje podle oprávnění uživatele v daném úložišti.The GitHub editing UI responds to your permissions on the repository. Předchozí obrázky jsou přesné pro přispěvatele, kteří nemají oprávnění k zápisu do cílového úložiště.The preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub automaticky vytvoří ve vašem účtu fork cílového úložiště.GitHub automatically creates a fork of the target repository in your account. Pokud máte oprávnění k zápisu do cílového úložiště, GitHub vytvoří v cílovém úložišti novou větev.If you have write-access to the target repository, GitHub creates a new branch in the target repo. Název větve má formát <GitHubId>-patch-n a používá vaše ID pro GitHub a číselný identifikátor pro větev opravy.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Žádosti o přijetí změn používáme u všech změn, tedy i u změn od přispěvatelů, kteří mají oprávnění k zápisu.We use pull requests for all changes, even for contributors that have write-access. U většiny úložišť je větev master chráněná, takže aktualizace je nutné odesílat jako žádosti o přijetí změn.Most repositories have the master branch protected so that updates must be submitted as pull requests.

Prostředí pro úpravy v prohlížeči je nejvhodnější pro drobné nebo málo časté změny.The in-browser editing experience is best for minor or infrequent changes. 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ě.If you make large contributions or use advanced Git features (such as branch management or advanced merge conflict resolution), you need to fork the repo and work locally.

Poznámka

Pokud je to povolené, můžete článek upravit v libovolném jazyce, přičemž podle typu úpravy se stane následující:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. Jakákoli schválená jazyková změna zároveň pomůže vylepšit náš modul strojového překladu.any linguistic change that is approved, will also help improve our Machine Translation engine
  2. Jakákoliv úprava, která podstatně změní obsah článku, se zpracuje interně a změna se odešle do stejného článku v angličtině, takže pokud bude schválena, bude se lokalizovat do všech jazyků.any edit that significantly modifies the content of the article will be handled internally to submit a change to the same article in English so that it will get localized in all languages if approved. Vámi navržená vylepšení pozitivně ovlivní nejen články ve vašem vlastním jazyce, ale také ve všech dostupných jazycích.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Revize otevřených žádostí o přijetí změnReview open PRs

S novými tématy se můžete seznámit před jejich publikováním tak, že zkontrolujete aktuálně otevřené žádosti o přijetí změn.You can read new topics before they are published by checking the currently open PRs. Revize se řídí procesem toku GitHubu.Reviews follow the GitHub flow process. Ve veřejných úložištích můžete vidět navrhované aktualizace a nové články.You can see proposed updates or new articles in public repositories. Seznamte se s nimi a přidejte svoje komentáře.Review them and add your comments. Podívejte se na libovolné z našich úložišť dokumentů a zkontrolujte otevřené žádosti o přijetí změn v oblastech, které vás zajímají.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. Zpětná vazba komunity na navrhované aktualizace pomáhá celé komunitě.Community feedback on proposed updates helps the entire community.

Vytváření užitečných položek problémůCreate quality issues

Naše dokumenty jsou výsledkem nepřetržitě probíhající práce.Our docs are a continuous work in progress. Vhodně vytvořené položky problémů pomáhají zaměřit naše úsilí na to, co má pro komunitu nejvyšší prioritu.Good issues help us focus our efforts on the highest priorities for the community. Čím více podrobností zadáte, tím je položka problému užitečnější.The more detail you can provide, the more helpful the issue. Sdělte nám, co jste hledali.Tell us what information you sought. Sdělte nám, jaké termíny jste při hledání použili.Tell us the search terms you used. Pokud nemůžete zahájit práci, sdělte nám, jak se chcete s neznámou technologií začít seznamovat.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Mnoho stránek dokumentace Microsoftu obsahuje v dolní části sekci Feedback (Vaše názory), kde můžete zanechat svůj názor na produkt (Product feedback) nebo na obsah (Content feedback). Umožníte nám tak zaznamenávat konkrétní problémy týkající se daného článku.Many of Microsoft's documentation pages have a Feedback section at the bottom of the page where you can click to leave Product feedback or Content feedback to track issues that are specific to that article.

Položky problémů umožňují zahájit konverzaci o tom, co je potřeba udělat.Issues start the conversation about what's needed. Tým pro obsah bude na tyto položky problémů reagovat návrhy, co můžeme přidat, a požádá vás o váš názor.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Až vytvoříme koncept, požádáme vás o revizi dané žádosti o přijetí změn.When we create a draft, we'll ask you to review the PR.

Zapojte se víceGet more involved

Další témata vám pomáhají začít produktivně přispívat na web Microsoft Docs. Vysvětlují, jak používat úložiště GitHub, nástroje Markdown a rozšíření používaná na platformě Microsoft Docs.Other topics help you get started productively contributing to Microsoft Docs. They explain working with GitHub repositories, Markdown tools, and extensions used in the Microsoft Docs platform.