Microsoft Docs-közreműködői útmutató – áttekintésMicrosoft Docs contributor guide overview

Üdvözöljük a docs.microsoft.com (más néven Docs) közreműködői útmutatójában!Welcome to the docs.microsoft.com (Docs) Contributor Guide!

A Microsoft számos dokumentumkészlete nyílt forrású, és a GitHubon elérhető.Several of the Microsoft documentation sets are open source and hosted on GitHub. Nem minden dokumentumkészlet teljesen nyílt forrású, de sok rendelkezik nyilvánosan elérhető adattárakkal, ahol Ön javasolt módosításokat végezhet lekéréses kérelmekkel.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. Ez a nyílt forráskódú megközelítés leegyszerűsíti és javítja a termékfejlesztő mérnökök, a tartalomkészítő csapatok és az ügyfelek közötti kommunikációt, valamint további előnyökkel szolgál:This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • A nyílt forrású adattáraknál a tervezés nyílt, hogy visszajelzést kapjanak, milyen dokumentumokra van a leginkább szükség.Open source repos plan in the open to get feedback on what docs are most needed.
  • A nyílt forrású adattáraknál az áttekintés nyílt, hogy már az első kiadásban a leghasznosabb tartalom jelenhessen meg.Open source repos review in the open to publish the most helpful content on our first release.
  • Az nyílt forrású adattáraknál a frissítés nyílt, hogy egyszerűbb legyen a tartalom folyamatos javítása.Open source repos update in the open to make it easier to continuously improve the content.

A docs.microsoft.com felhasználói felületén a GitHub-munkafolyamatok közvetlen integrációja ezt még egyszerűbbé teszi.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. Kezdje a megtekintett dokumentum szerkesztésével.Start by editing the document you are viewing. Vagy segítsen új témakörök áttekintésével vagy minőségi problémák jelentésével.Or, help by reviewing new topics, or create quality issues.

Fontos

A docs.microsoft.com felületen közzétevő tárházak mindegyike elfogadta a Microsoft nyílt forráskódra vonatkozó viselkedési szabályzatát vagy a .NET Foundation viselkedési szabályzatát.All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. További információkért keresse fel a Viselkedési szabályzattal kapcsolatos gyakori kérdések oldalát,For more information, see the Code of Conduct FAQ. illetve elküldheti kérdéseit és észrevételeit az opencode@microsoft.com vagy a conduct@dotnetfoundation.org címre.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

A nyilvános tárházakban publikált dokumentációhoz és kódmintákhoz beküldött kisebb javításokra vagy pontosításokra a docs.microsoft.com használati feltételei vonatkoznak.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. Új vagy jelentős módosítások esetén a lekéréses kérelemben megjelenik egy megjegyzés, amely arra szólítja fel, hogy ha nem Microsoft-alkalmazott, akkor küldje be az online Közreműködői Licencszerződést (CLA).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. A lekéréses kérelmet csak akkor tekinthetjük át vagy fogadhatjuk el, ha előzőleg kitöltötte az online űrlapot.We need you to complete the online form before we can review or accept your pull request.

Meglévő dokumentumok gyors szerkesztéseQuick edits to existing documents

A gyors szerkesztésekkel leegyszerűsíthető a jelentési folyamat, és javíthatók a dokumentum kisebb hibái és hiányosságai.Quick edits streamline the process to report and fix small errors and omissions in documents. Minden erőfeszítés ellenére kisebb nyelvtani vagy helyesírási hibák előfordulhatnak a közzétett dokumentumokban.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Problémák jelzésével jelentheti a hibákat, de gyorsabb és egyszerűbb a probléma megoldásához lekéréses kérelmet (PR) létrehozni, ha ez a lehetőség is elérhető.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. Egyes dokumentumok oldalán lehetőség van közvetlenül a böngészőben is a tartalom szerkesztésére.Some docs pages allow you to edit content directly in the browser. Ilyen esetben az alábbi képen láthatóhoz hasonló Szerkesztés gomb is megjelenik az oldalon.If so, you'll see an Edit button like the one shown below. Ha rákattint a Szerkesztés (vagy más nyelven ugyanilyen) gombra, akkor megnyílik a forrásfájl a GitHubon.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. Ha nem jelenik meg a Szerkesztés gomb, az azt jelenti, hogy a dokumentum nem módosítható az oldalon.If the Edit button is missing, that means the documentation page is not available to be changed.

    Az Edit (Szerkesztés) hivatkozás helye

  2. A cikk szerkesztéséhez kattintson a ceruza ikonra, ahogy alább látható.Next, click the pencil icon, to edit the article as shown. Ha a ceruza ikon kiszürkítve látható, akkor jelentkezzen be a GitHub-fiókjába, vagy hozzon létre egy új fiókot.If the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

    A ceruzaikon helye

  3. Végezze el a módosításokat a webszerkesztőben.Make your changes in the web editor. A módosítás formázásának ellenőrzéséhez kattintson a Preview changes (Módosítások előnézete) fülre.Click the Preview changes tab to check the formatting of your change.

  4. Miután elvégezte a módosításokat, görgessen a lap aljára.Once you have made your changes, scroll to the bottom of the page. Adja meg a módosítás címét és leírását, majd kattintson a Propose file change (Fájlmódosítás javasolása) elemre az alábbi ábrának megfelelően:Enter a title and description for your changes and click Propose file change as shown in the following figure:

    Fájlmódosítás javasolása

  5. A módosításjavaslat után arra kell kérnie a tárház tulajdonosait, hogy „kérjék le” (angolul pull) a módosításokat a tárházukba.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. Ezt a lekéréses kérelem (angolul pull request) használatával teheti meg.This is done using something called a "pull request". Amikor a fenti Propose file change (Fájlmódosítás javasolása) lehetősége kattintott, akkor az alábbi képen láthatóhoz hasonló oldalra került: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:

    lekéréses kérelem létrehozása

    Kattintson a Create pull request (Lekéréses kérelem létrehozása) lehetőségre, a lekéréses kérelemhez adjon meg egy címet (és ha szeretné, leírást is), majd kattintson újra a Create pull request (Lekéréses kérelem létrehozása) elemre.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (Ha még nem ismeri a GitHubot, tekintse meg a lekéréses kérelmeket ismertető cikket további információért.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. Ennyi az egész!That's it! A tartalomcsapat tagjai át fogják tekinteni és egyesíteni fogják a lekéréses kérelmet.Content team members will review and merge your PR. Ha nagyobb módosításokat végzett, változtatásokat kérő visszajelzést kaphat.You may get some feedback requesting changes if you made larger changes.

A GitHub szerkesztői felülete az adattárhoz tartozó engedélyeknek megfelelő választ ad.The GitHub editing UI responds to your permissions on the repository. Az előző képek olyan közreműködő esetén pontosak, akinek nincsenek írási jogosultságai a céladatbázisban.The preceding images are accurate for contributors that do not have write permissions to the target repository. A GitHub automatikusan létrehoz egy adattármásolatot a céladattárról az Ön fiókjában.GitHub automatically creates a fork of the target repository in your account. Ha Önnek írási engedélye van a céladattárhoz, a GitHub létrehoz egy új ágat a céladattárban.If you have write-access to the target repository, GitHub creates a new branch in the target repo. Az ág nevének formátuma <GitHubId>-patch-n, ami a GitHub-azonosítót tartalmazza, valamint a javítóág számazonosítóját.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Minden módosításhoz lekéréses kérelmeket használunk, még az írási engedéllyel rendelkező közreműködőknél is.We use pull requests for all changes, even for contributors that have write-access. A legtöbb adattárban a master ág védett, ezért a frissítéseket lekéréses kérelemként kell beküldeni.Most repositories have the master branch protected so that updates must be submitted as pull requests.

A böngészőn belüli szerkesztési környezet kisebb vagy ritka módosítások esetén a legjobb.The in-browser editing experience is best for minor or infrequent changes. Ha nagyobb terjedelmű szövegeket ír, vagy speciális Git-funkciókat (például ágkezelést vagy fejlett egyesítéskori ütközésfeloldást) használ, akkor adattármásolatot kell készítenie, és a helyi számítógépen kell dolgoznia.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.

Megjegyzés

Ha ez a lehetőség engedélyezve van, akkor bármilyen nyelvű cikket módosíthat, és a szerkesztés típusától függően a következő történik majd:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. Minden jóváhagyott nyelvi módosítás hozzájárul a gépi fordítási motorunk fejlesztéséhez is.any linguistic change that is approved, will also help improve our Machine Translation engine
  2. Az olyan módosítások, amelyek jelentős mértékben megváltoztatják a cikk tartalmát, belsőleg lesznek kezelve, melynek során a módosítást ugyanannak a cikknek az angol nyelvű változatán is alkalmazzuk, így az minden nyelvre lokalizálva lesz, ha a módosítást jóváhagyják.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. A javasolt módosítások nem csak a saját nyelvén, de minden elérhető nyelven is megjelennek a cikkeknél.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Nyitott lekéréses kérelmek áttekintéseReview open PRs

A jelenleg nyitott lekéréses kérelmek átnézésével elolvashatja az új témaköröket, még mielőtt közzétennék őket.You can read new topics before they are published by checking the currently open PRs. Az áttekintések a GitHub-folyamatot követik.Reviews follow the GitHub flow process. Megtekintheti a javasolt frissítéseket és az új cikkeket a nyilvános adattárakban.You can see proposed updates or new articles in public repositories. Tekintse át őket, és fűzzön hozzájuk megjegyzéseket.Review them and add your comments. Keresse fel bármelyik dokumentációs adattárunkat, majd tekintse meg a nyitott lekéréses kérelmeket az Önt érdeklő területeken.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. A javasolt frissítéseket illető közösségi visszajelzések az egész közösséget segítik.Community feedback on proposed updates helps the entire community.

Minőségi problémák jelzéseCreate quality issues

Dokumentumainkat folyamatosan fejlesztjük.Our docs are a continuous work in progress. A jelzett problémák segítenek, hogy erőfeszítéseinket a közösség számára legfontosabb dolgokra összpontosítsuk.Good issues help us focus our efforts on the highest priorities for the community. Minél több részletet meg tud adni, annál nagyobb segítségünkre lesz a probléma.The more detail you can provide, the more helpful the issue. Mondja el, milyen információt keresett.Tell us what information you sought. Írja le a használt keresési kifejezéseket.Tell us the search terms you used. Ha nem tudta megtenni az első lépéseket, mondja el, hogyan szeretné elkezdeni egy új technológia felfedezését.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Sok Microsoft-dokumentum oldalán található egy Visszajelzés szakasz is az oldal alján, ahol egy kattintás után visszajelzést küldhet a termékről vagy a tartalomól, és nyomon követheti a cikkel kapcsolatos problémákat is.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.

A problémák jelzésével elindul a párbeszéd arról, hogy mire van szükség.Issues start the conversation about what's needed. A tartalomcsapat ezekre a jelzett problémákra a dokumentáció bővítésére vonatkozó ötletekkel fog válaszolni, és megkérdezi a véleményét.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Vázlat létrehozásakor megkérjük, hogy tekintse át a lekéréses kérelmet.When we create a draft, we'll ask you to review the PR.

Vegyen részt még több mindenbenGet more involved

Más témakörök segítenek, hogy termelékenyen hozzájárulhasson a Microsoft Docs tartalmainak bővítéséhez. Elmagyarázzák a Microsoft Docs platformon használt GitHub-tárházakkal, Markdown-eszközökkel és bővítményekkel való munkavégzést.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.