Skip to main content

자체 리뷰 체크리스트

리뷰를 위해 끌어오기 요청을 제출하기 전에 먼저 직접 리뷰해야 합니다.

"GitHub Docs에 기여" 섹션의 문서는 설명서 자체를 참조하며 GitHub 직원 및 오픈 소스 기여자에 대한 리소스입니다.

리뷰를 위해 GitHub Docs 팀에 변경 내용을 제출하기 전에 아래 목록을 리뷰하여 자체 리뷰를 완료하세요.

  • 콘텐츠 디자인 계획이 있는 경우 변경 내용이 계획에 설명된 사용자 환경 및 목표를 충족하는지 확인합니다.
  • 끌어오기 요청을 연 후 스테이징에서 변경 내용을 확인하여 문서가 예상대로 렌더링되고 원본과 일치하는지 확인합니다. 이렇게 하면 오타, 스타일 가이드를 따르지 않는 콘텐츠 또는 버전 관리 문제로 인해 렌더링되지 않는 콘텐츠와 같은 문제를 발견할 수 있습니다.
  • 기술 정확도에 대한 변경 내용을 리뷰합니다.
  • 전체 끌어오기 요청을 리뷰하여 번역할 수 있는 콘텐츠를 만드는 방법에 대한 참고 자료를 따르는지 확인합니다. 자세한 내용은 "번역할 콘텐츠 작성"을(를) 참조하세요.
  • 스타일 가이드의 문법, 맞춤법 및 준수에 대한 변경 내용을 확인합니다. 자세한 내용은 "스타일 가이드"을(를) 참조하세요.
  • 새 버전 관리가 추가되었거나 기존 버전 관리가 변경된 경우 사용 가능한 각 버전의 문서를 보는 동안 변경 내용이 예상대로 렌더링되는지 확인합니다.
  • 끌어오기 요청에 실패한 검사가 있는 경우 모두 성공할 때까지 문제를 해결합니다.