Microsoft Docs 참여자 가이드 개요Microsoft Docs contributor guide overview

docs.microsoft.com(Docs) 참여자 가이드에 관심을 가져주셔서 감사합니다.Welcome to the docs.microsoft.com (Docs) Contributor Guide!

몇몇 Microsoft 설명서 집합은 오픈 소스로, GitHub에서 호스트됩니다.Several of the Microsoft documentation sets are open source and hosted on GitHub. 일부 문서 세트는 완전히 오픈 소스는 아니지만, 많은 문서 세트에는 끌어오기 요청을 통해 제안된 변경을 수행할 수 있는 공용 리포지토리가 있습니다.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. 이러한 오픈 소스 방식은 제품 엔지니어와 콘텐츠 팀, 고객 간 커뮤니케이션을 간소화하고 개선하며 다음과 같은 이점을 제공합니다.This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • 오픈 소스 리포지토리의_공개 계획_을 통해 가장 필요한 문서에 대한 피드백을 받습니다.Open source repos plan in the open to get feedback on what docs are most needed.
  • 오픈 소스 리포지토리의_공개 검토_를 통해 첫 번째 릴리스에서 가장 유용한 콘텐츠를 게시할 수 있습니다.Open source repos review in the open to publish the most helpful content on our first release.
  • 오픈 소스 리포지토리의_공개 업데이트_를 통해 콘텐츠를 지속적으로 개선할 수 있습니다.Open source repos update in the open to make it easier to continuously improve the content.

docs.microsoft.com의 사용자 환경은 GitHub 워크플로와 직접 통합되어 훨씬 더 간단합니다.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. 보고 있는 문서를 편집하여 시작하세요.Start by editing the document you are viewing. 또는 새 항목을 검토하여 도움을 주거나 품질 이슈를 작성하세요.Or, help by reviewing new topics, or create quality issues.

중요

docs.microsoft.com에 게시하는 모든 리포지토리는 Microsoft Open Source Code of Conduct(Microsoft 오픈 소스 규정) 또는 .NET Foundation Code of Conduct(.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. 자세한 내용은 준수 사항 FAQ를 참조하세요.For more information, see the Code of Conduct FAQ. 또는 opencode@microsoft.com이나 conduct@dotnetfoundation.org에 궁금한 사항을 문의하거나 의견을 제시하세요.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

공용 리포지토리의 설명서 및 코드 예제에 대한 사소한 수정 또는 확인 내용은 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. 변경 내용이 새롭거나 중요한 내용일 경우 Microsoft 직원이 아닌 경우에 한해 끌어오기 요청에서 온라인 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. 온라인 양식을 먼저 작성한 후 Microsoft에서 끌어오기 요청을 검토하거나 수락할 수 있습니다.We need you to complete the online form before we can review or accept your pull request.

기존 문서의 빠른 편집Quick edits to existing documents

빠른 편집은 문서의 사소한 오류 및 누락을 보고하고 수정하는 프로세스를 간소화합니다.Quick edits streamline the process to report and fix small errors and omissions in documents. 오류를 최소화하려는 모든 노력에도 불구하고 게시되는 문서에서 사소한 문법 및 맞춤법 오류가 발견될 수 있습니다.Despite all efforts, small grammar and spelling errors do make their way into our published documents. 이슈를 작성해 오류를 보고할 수도 있지만, PR(끌어오기 요청)을 만들면 문제를 더 빠르고 쉽게 해결할 수 있습니다(옵션을 사용할 수 있는 경우).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. 일부 문서 페이지의 경우 브라우저에서 직접 콘텐츠를 편집할 수 있습니다.Some docs pages allow you to edit content directly in the browser. 해당하는 경우 아래 표시된 것처럼 편집 단추가 표시됩니다.If so, you'll see an Edit button like the one shown below. 편집(또는 지역화된) 단추를 클릭하면 GitHub의 원본 파일로 이동합니다.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. 편집 단추(텍스트 없는 연필 아이콘)가 없는 경우 설명서 페이지를 수정할 수 없습니다.If the Edit button (pencil icon without text) is missing, that means the documentation page is not available to be changed.

    편집 링크의 위치

  2. 다음으로 연필 아이콘을 클릭하여 표시된 것처럼 문서를 편집합니다.Next, click the pencil icon, to edit the article as shown. 연필 아이콘이 회색으로 표시되는 경우 GitHub 계정으로 로그인하거나 새 계정을 만들어야 합니다.If the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

    연필 아이콘의 위치

  3. 웹 편집기에서 편집합니다.Make your changes in the web editor. 변경 내용 미리 보기 탭을 클릭하여 변경 내용의 서식을 확인합니다.Click the Preview changes tab to check the formatting of your change.

  4. 변경했으면 페이지 하단으로 스크롤합니다.Once you have made your changes, scroll to the bottom of the page. 변경 내용의 제목 및 설명을 입력하고 다음 그림에 표시된 것처럼 파일 변경 제안을 클릭합니다.Enter a title and description for your changes and click Propose file change as shown in the following figure:

    파일 변경 제안

  5. 변경을 제안했으므로 리포지토리 소유자에게 변경 사항을 리포지토리로 “끌어오도록” 요청해야 합니다.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. 이 작업은 “끌어오기 요청”을 사용하여 수행합니다.This is done using something called a "pull request". 위 그림에서 파일 변경 제안을 클릭한 경우 다음 그림과 같은 새 페이지로 이동됩니다.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:

    끌어오기 요청 만들기

    끌어오기 요청 만들기를 클릭하고, 끌어오기 요청 제목(및 필요한 경우 설명)을 입력한 다음, 끌어오기 요청 만들기를 다시 클릭합니다.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (GitHub을 처음 사용하는 경우 자세한 내용은 끌어오기 요청 정보를 참조하세요.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. 이것으로 끝입니다.That's it! 콘텐츠 팀 구성원이 PR을 검토하고 병합합니다.Content team members will review and merge your PR. 변경을 많이 수행한 경우 변경을 요청하는 피드백을 받을 수 있습니다.You may get some feedback requesting changes if you made larger changes.

GitHub 편집 UI는 리포지토리에 대한 사용 권한에 따라 달라집니다.The GitHub editing UI responds to your permissions on the repository. 대상 리포지토리에 대한 쓰기 권한이 없는 contributor의 경우 이전 이미지가 정확합니다.The preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub는 해당 계정의 대상 리포지토리의 포크를 자동으로 만듭니다.GitHub automatically creates a fork of the target repository in your account. 대상 리포지토리에 대한 쓰기 권한이 있는 경우 GitHub는 대상 리포지토리에 새 분기를 만듭니다.If you have write-access to the target repository, GitHub creates a new branch in the target repo. 분기 이름의 형식은 GitHub ID와 패치 분기에 대한 숫자 식별자를 사용하는 <GitHubId>-patch-n입니다.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

쓰기 권한이 있는 기여자의 경우에도, Microsoft는 모든 변경 내용에 대해 끌어오기 요청을 사용합니다.We use pull requests for all changes, even for contributors that have write-access. 대부분의 리포지토리에는 보호되는 master 분기가 있으므로 업데이트는 끌어오기 요청으로 제출해야 합니다.Most repositories have the master branch protected so that updates must be submitted as pull requests.

브라우저 내 편집 환경은 변경 내용이 적거나 자주 변경하지 않는 경우 적합합니다.The in-browser editing experience is best for minor or infrequent changes. 편집 적용 범위가 넓거나 고급 Git 기능(예: 분기 관리, 고급 병합 충돌 해결)을 사용하는 경우 리포지토리를 포크하고 로컬에서 작업해야 합니다.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.

참고

활성화된 경우 문서를 임의 언어로 편집하고, 편집 유형에 따라 다음 작업이 수행됩니다.If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. 승인된 언어 변경은 기계 번역 엔진을 개선하는 데에도 도움이 됩니다.any linguistic change that is approved, will also help improve our Machine Translation engine
  2. 문서 내용을 많이 수정하는 편집은 내부적으로 처리되어 동일한 문서에 대한 변경 사항을 영어로 제출하므로, 승인된 경우 모든 언어로 지역화됩니다.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. 제안한 개선 사항은 해당 언어로 된 문서뿐만 아니라 사용 가능한 모든 언어로 된 문서에 긍정적으로 영향을 줍니다.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

진행 중인 PR 검토Review open PRs

현재 진행 중인 PR을 확인하여 새 항목이 게시되기 전에 읽을 수 있습니다.You can read new topics before they are published by checking the currently open PRs. 검토는 GitHub 흐름 프로세스를 따릅니다.Reviews follow the GitHub flow process. 공개 리포지토리에서 제안된 업데이트 또는 새 문서를 볼 수 있습니다.You can see proposed updates or new articles in public repositories. 이를 검토하고 댓글을 추가하세요.Review them and add your comments. 원하는 문서 리포지토리를 살펴보고, 관심 있는 영역의 진행 중인 PR(끌어오기 요청)을 확인합니다.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. 제안된 업데이트에 대한 커뮤니티 피드백은 전체 커뮤니티에 도움이 됩니다.Community feedback on proposed updates helps the entire community.

품질 이슈 작성하기Create quality issues

Microsoft의 문서는 계속 진행 중인 작업입니다.Our docs are a continuous work in progress. 유용한 이슈들 덕분에 커뮤니티에 가장 중요한 콘텐츠에 집중할 수 있습니다.Good issues help us focus our efforts on the highest priorities for the community. 더 자세한 정보를 제공할수록 문제에 더 도움이 됩니다.The more detail you can provide, the more helpful the issue. 찾은 정보를 알려주세요.Tell us what information you sought. 사용한 검색 용어를 알려주세요.Tell us the search terms you used. 시작하기가 어렵다면 새로운 기술을 어떻게 활용하면 좋을지 공유해 주세요.If you can't get started, tell us how you want to start exploring unfamiliar technology.

많은 Microsoft의 설명서 페이지에는 페이지 아래쪽에 클릭하여 해당 문서와 관련된 문제를 추적하기 위해 제품 피드백 또는 콘텐츠 피드백을 남길 수 있는 피드백 섹션이 있습니다.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.

문제를 통해 필요한 사항에 대한 대화가 시작됩니다.Issues start the conversation about what's needed. 콘텐츠 팀은 추가할 수 있는 아이디어를 가지고 이러한 문제에 응답하며 사용자의 의견을 구합니다.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. 사용자가 초안을 만들면 Microsoft에서 PR 검토를 요청할 것입니다.When we create a draft, we'll ask you to review the PR.

더 많이 참여하기Get more involved

기타 항목은 Microsoft Docs에 생산적으로 기여를 시작하는 데 도움이 됩니다. GitHub 리포지토리, Markdown 도구, 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.