Microsoft Learn 설명서 기여자 가이드 개요

Microsoft Learn 설명서 기여자 가이드에 오신 것을 환영합니다!

Microsoft Learn에서 다른 사용자와 전문 지식을 공유하면 모든 사람이 더 많은 것을 성취할 수 있습니다. 이 가이드의 정보를 사용하여 새 문서를 Microsoft Learn에 게시하거나 기존 게시된 문서를 업데이트할 수 있습니다.

몇몇 Microsoft 설명서 집합은 오픈 소스로, GitHub에서 호스트됩니다. 일부 문서 세트는 완전히 오픈 소스는 아니지만, 많은 문서 세트에는 끌어오기 요청(PR)을 통해 변경을 제안할 수 있는 공용 리포지토리가 있습니다. 이러한 오픈 소스 방식은 제품 엔지니어와 콘텐츠 팀, 고객 간 커뮤니케이션을 간소화하고 개선하며 다음과 같은 이점을 제공합니다.

  • 오픈 소스 리포지토리의공개 계획을 통해 가장 필요한 문서에 대한 피드백을 받습니다.
  • 오픈 소스 리포지토리의공개 검토를 통해 첫 번째 릴리스에서 가장 유용한 콘텐츠를 게시할 수 있습니다.
  • 오픈 소스 리포지토리의공개 업데이트를 통해 콘텐츠를 지속적으로 개선할 수 있습니다.

Microsoft Learn의 사용자 환경은 GitHub 워크플로를 직접 통합하여 더 쉽게 만들 수 있습니다. 보고 있는 문서를 편집하는 것부터 시작하세요. 또는 새 항목을 검토하거나 품질 이슈를 작성하여 도움을 주세요.

중요

Microsoft Learn에 게시하는 모든 리포지토리는 Microsoft 오픈 소스 행동 강령 또는 .NET Foundation 행동 강령을 채택했습니다. 자세한 내용은 준수 사항 FAQ를 참조하세요. 또는 opencode@microsoft.com이나 conduct@dotnetfoundation.org에 궁금한 사항을 문의하거나 의견을 제시하세요.

공용 리포지토리의 설명서 및 코드 예제에 대한 사소한 수정 또는 설명은 learn.microsoft.com 사용 약관에 포함됩니다. 변경 내용이 새롭거나 중요한 내용일 경우 Microsoft 직원이 아닌 경우에 한해 PR에서 온라인 CLA(참가 라이선스 계약)를 제출하도록 요청하는 주석이 생성됩니다. 온라인 양식을 먼저 작성한 후 Microsoft에서 PR을 검토하거나 수락할 수 있습니다.

설명서 빠른 편집

빠른 편집은 문서의 사소한 오류 및 누락을 보고하고 수정하는 프로세스를 간소화합니다. 오류를 최소화하려는 모든 노력에도 불구하고 게시되는 문서에서 사소한 문법 및 맞춤법 오류가 발견될 수 있습니다. 이슈를 작성해 오류를 보고할 수도 있지만, PR을 만들면 문제를 더 빠르고 쉽게 해결할 수 있습니다(옵션을 사용할 수 있는 경우).

  1. 일부 문서 페이지의 경우 브라우저에서 직접 콘텐츠를 편집할 수 있습니다. 해당하는 경우 아래 표시된 것처럼 편집 단추가 표시됩니다. 편집(또는 같은 맥락으로 번역된) 단추를 선택하면 GitHub의 원본 파일로 이동합니다.

    문서 편집 링크의 위치.

    편집 단추가 없으면 콘텐츠가 퍼블릭 기여에 공개되지 않는다는 의미입니다. 일부 페이지는(예: 코드의 인라인 설명서에서) 생성되며, 해당 페이지가 속한 프로젝트에서 편집해야 합니다.

  2. 문서를 편집하려면 연필 아이콘을 선택합니다. 연필 아이콘이 회색으로 표시되는 경우 GitHub 계정으로 로그인하거나 새 계정을 만들어야 합니다.

    포크 및 편집 연필 아이콘의 위치.

  3. 웹 편집기에서 파일을 편집합니다. 미리 보기 탭을 선택하여 변경 내용의 서식을 확인합니다.

  4. 편집을 마쳤으면 페이지 아래쪽으로 스크롤합니다. 변경 제안 영역에서 선택적으로 변경 내용에 대한 제목과 설명을 입력합니다. 제목은 커밋 메시지의 첫 번째 줄이 됩니다. 변경 내용 제안을 선택하여 변경 내용을 커밋합니다.

    파일 변경 제안 및 커밋.

  5. 변경 내용을 제안하고 커밋했으므로 리포지토리 소유자에게 변경 사항을 리포지토리로 “끌어오도록” 요청해야 합니다. 이 작업은 “끌어오기 요청(PR)”을 사용하여 수행합니다. 변경 제안을 선택하면 다음과 비슷한 새 페이지가 표시됩니다.

    변경 비교 및 끌어오기 요청 만들기.

    끌어오기 요청 만들기를 선택합니다. 그런 다음, PR 요청의 제목과 설명을 입력한 후 끌어오기 요청 만들기를 선택합니다. GitHub를 처음 사용하는 경우 끌어오기 요청 정보에서 자세한 내용을 참조하세요.

  6. 정말 간단하죠. PR이 승인되면 콘텐츠 팀 구성원이 PR을 검토 및 병합합니다. 변경을 요청하는 피드백을 받을 수 있습니다.

GitHub 편집 UI는 리포지토리에 대한 사용 권한에 따라 달라집니다. 이전 이미지는 대상 리포지토리에 대한 쓰기 권한이 없는 참여자를 위한 것입니다. GitHub는 해당 계정의 대상 리포지토리의 포크를 자동으로 만듭니다. 새로 만든 포크 이름에는 기본적으로 양식 GitHubUsername/RepositoryName이 있습니다. 대상 리포지토리(예: 포크)에 대한 쓰기 권한이 있는 경우 GitHub는 대상 리포지토리에 새 분기를 만듭니다. 분기 이름은 기본 형식은 패치 분기에 대한 숫자 식별자를 사용하는 patch-n입니다.

쓰기 권한이 있는 참여자의 경우에도, Microsoft는 모든 변경 내용에 대해 PR을 사용합니다. 대부분의 리포지토리는 기본 분기를 보호하므로 업데이트는 PR로 제출되어야 합니다.

브라우저 내 편집 환경은 변경 내용이 적거나 자주 변경하지 않는 경우 적합합니다. 편집 적용 범위가 넓거나 고급 Git 기능(예: 분기 관리, 고급 병합 충돌 해결)을 사용하는 경우 리포지토리를 포크하고 로컬에서 작업해야 합니다.

참고

지역화된 대부분 설명서는 GitHub를 통해 피드백을 편집하거나 제공하는 기능을 제공하지 않습니다. 지역화된 콘텐츠에 대한 피드백을 제공하려면 aka.ms/DocSiteLocFeedback에서 제공되는 메일 템플릿을 사용하세요.

진행 중인 PR 검토

진행 중인 PR 큐를 확인하여 새 항목이 게시되기 전에 읽을 수 있습니다. 검토는 GitHub 흐름 프로세스를 따릅니다. 공개 리포지토리에서 제안된 업데이트 또는 새 문서를 볼 수 있습니다. 이를 검토하고 댓글을 추가하세요. Microsoft Learn 리포지토리를 살펴보고 관심 있는 영역에 대해 열려 있는 PR을 확인합니다. 제안된 업데이트에 대한 커뮤니티 피드백은 전체 커뮤니티에 도움이 됩니다.

품질 이슈 작성하기

Microsoft의 문서는 계속 진행 중인 작업입니다. 유용한 이슈들 덕분에 커뮤니티에 가장 중요한 콘텐츠에 집중할 수 있습니다. 더 자세한 정보를 제공할수록 문제에 더 도움이 됩니다. 찾은 정보를 알려주세요. 사용한 검색 용어를 알려주세요. 시작하기가 어렵다면 새로운 기술을 어떻게 활용하면 좋을지 공유해 주세요.

많은 Microsoft의 설명서 페이지 아래에는 피드백 섹션이 있어 해당 문서와 관련된 문제를 추적하기 위해 제품 피드백 또는 콘텐츠 피드백을 남길 수 있습니다.

문제를 통해 필요한 사항에 대한 대화가 시작됩니다. 콘텐츠 팀은 추가할 수 있는 아이디어를 가지고 이러한 문제에 응답하며 사용자의 의견을 구합니다. 사용자가 초안을 만들면 Microsoft에서 PR 검토를 요청할 것입니다.

더 많이 참여하기

이 가이드의 다른 항목은 Microsoft Learn에 생산적으로 기여하기 시작하는 데 도움이 됩니다. Microsoft Learn 콘텐츠에 사용되는 GitHub 리포지토리, Markdown 도구 및 확장 작업에 대해 설명합니다.