GitHub Docs에 기여하기

GitHub 설명서는 오픈 소스입니다. 누구나 https://github.com/github/docs을(를) 통해 공용 docs 리포지토리의 문서에 기여할 수 있습니다. GitHub 직원은 docs-internal(이)라고 부르는 이 리포지토리의 복사본에서 설명서를 작업합니다. 두 리포지토리는 둘 다 최신 상태를 유지하도록 자동으로 동기화되며 변경 내용이 두 리포지토리의 main 분기에 병합됩니다. 간단히 하기 위해 GitHub Docs에 기여하는 방법에 대한 문서에서는 "설명서 리포지토리"라고 지칭합니다.

설명서 리포지토리는 docs.github.com에 게시된 설명서에 대해 논의하고 공동 작업할 수 있는 장소입니다.

문제

문제는 기여자 도울 수 있는 작업을 추적하는 데 사용합니다. 문제에 triage 레이블이 있는 경우 아직 검토하지 않았으므로 작업을 시작해서는 안 됩니다.

설명서 콘텐츠 또는 업데이트해야 하는 docs.github.com 웹 사이트에 대한 내용을 찾은 경우 열려 있는 문제를 검색하여 다른 사용자가 동일한 내용을 보고했는지 확인합니다. 새 항목인 경우 템플릿을 사용하여 문제를 엽니다. 이 문제를 사용하여 해결하려는 문제에 대한 대화를 나눌 것입니다.

끌어오기 요청

끌어오기 요청은 리포지토리의 변경 내용을 제안하는 방법입니다. 이러한 변경 내용을 병합하면 24시간 이내에 라이브 사이트에 배포됩니다.

REST API 참조 설명서에 대한 모든 기여 수락할 수는 없습니다. REST API 참조 설명서에서 부정확한 부분을 발견하면 rest-api-description 리포지토리에서 문제를 엽니다.

GitHub 제품, 기능, 도구 및 확장만 문서화합니다. 기능이 작동하는 방식을 보여주기 위해 제3자 도구에 멘션 또는 연결할 수 있지만, GitHub을(를) 사용하여 공동 개발하지 않는 한 제3자 도구 또는 통합을 문서화하는 끌어오기 요청을 수락하지 않습니다.

사용자 본인의 끌어오기 요청 검토

다른 사용자가 검토할 준비가 된 것으로 표시하기 전에 항상 사용자 고유의 끌어오기 요청을 먼저 검토해야 합니다.

콘텐츠 변경의 경우 다음을 수행해야 합니다.

• 변경 내용이 콘텐츠 디자인 계획에 설명된 사용자 경험 및 목표를 충족하는지 확인합니다(있는 경우).
• 콘텐츠의 기술 정확도를 검토합니다.
• 문법, 철자 및 스타일 가이드 준수에 대하여 변경 내용을 확인합니다.
• 끌어오기 요청의 텍스트를 쉽게 번역할 수 있는지 확인합니다. 자세한 내용은 "번역할 콘텐츠 작성"을(를) 참조하세요.
• 새로운 또는 업데이트된 Liquid 문을 확인하여 버전 관리가 올바른지 확인합니다. 자세한 내용은 "설명서 버전 관리하기"을(를) 참조하세요.
• 변경한 모든 페이지의 미리 보기를 확인합니다. 끌어오기 요청을 제출하면 미리 보기가 자동으로 생성되고 링크가 끌어오기 요청에 추가됩니다. 미리 보기가 준비되기까지 몇 분 정도 걸리는 경우가 있습니다. 모든 항목이 예상대로 렌더링되고 있는지 확인합니다. 미리 보기를 확인하면 오타, 스타일 가이드를 따르지 않는 콘텐츠 또는 버전 관리 문제로 인해 렌더링되지 않는 콘텐츠와 같은 문제를 식별하는 데 도움이 됩니다. Markdown에서 식별하기 어려운 문제가 있을 수 있는 목록 및 테이블의 렌더링된 출력을 검사 합니다.
• 끌어오기 요청에 실패한 검사가 있는 경우 모두 성공할 때까지 문제를 해결합니다.

지원

우리는 지속적으로 변화하는 제품의 설명서에 대한 요구를 충족하기 위해 열심히 노력하는 소규모 팀입니다. 아쉽게도 이 리포지토리에서는 지원 요청에 도움을 제공하기 어렵습니다. 설명서와 관련이 없는 GitHub에 대한 문제가 있는 경우 GitHub 지원에 직접 문의하세요. 지원을 요청하는 문서 리포지토리에서 진행 중인 문제나 풀 요청에는 GitHub 지원팀에 문의하는 방법이 제공되며, 이후 종결되고 잠깁니다.

GitHub 계정에 문제가 있는 경우 지원에 문의하세요.

Translations

이 웹 사이트는 국제화되어 있으며 여러 언어로 제공됩니다. 이 리포지토리의 원본 콘텐츠는 영어로 작성됩니다. 내부 프로세스를 통해 번역을 자동화하고 전문 번역가와 협력하여 영어 콘텐츠를 지역화합니다.

번역 오류가 발견되면 세부 정보를 포함한 문제를 제기하세요.

현재 번역된 콘텐츠에 대한 끌어오기 요청을 수락하지 않습니다.

사이트 정책

GitHub의 사이트 정책은 docs.github.com에도 게시됩니다.

사이트 정책 섹션에서 오타를 찾으면 끌어오기 요청을 열어 수정할 수 있습니다. 다른 항목은 site-policy 리포지토리의 "기여"를 참조하세요.