다음을 통해 공유

끌어오기 요청 관리

이 문서에서는 PowerShell-Docs 리포지토리에서 끌어오기 요청을 관리하는 방법을 설명합니다. 이 문서는 PowerShell-Docs 팀의 구성원을 위한 작업 지원으로 설계되었습니다. 공개 기여자에게 프로세스 투명성을 제공하기 위해 이 정보를 여기에 게시합니다.

모범 사례

  • 검토를 요청합니다. PR을 제출하는 사람은 동료 검토 없이 PR을 병합하면 안 됩니다.
  • PR이 제출되면 동료 검토자를 할당합니다. 조기 할당을 사용하면 검토자가 편집 발언으로 더 빨리 응답할 수 있습니다.
  • 주석을 사용하여 제출되는 변경 내용의 특성을 설명합니다. 예를 들어 변경 내용이 사소한 경우 변경 내용을 설명하고 전체 기술 검토가 필요하지 않습니다. 검토자를 반드시 @mention 하십시오.
  • 작성자가 제안된 변경 사항을 더 쉽게 수락할 수 있도록 주석 제안 기능을 사용합니다. 자세한 내용은 끌어오기 요청에서 제안된 변경 내용 검토를 참조하세요.

PR 프로세스 단계

  1. 작성기: PR 만들기
    • PR 템플릿 작성
    • PR에서 해결한 문제를 연관시키세요
    • GitHub의 자동 설정 기능을 사용하여 문제 닫기
    • 검사 목록의 각 항목 진행 및 확인
  2. 작성자: 피어 리뷰어 할당
  3. 검토자: 교정 및 주석(필요한 경우)
  4. 작성기: 검토 피드백 통합
  5. 둘 다: 미리 보기 렌더링 검토
  6. 둘 다: 유효성 검사 보고서 검토 - 경고 및 오류 수정
  7. 검토자: "승인됨" 검토 표시
  8. 리포지토리 관리자: PR 병합

콘텐츠 검토자 검사 목록

보다 포괄적인 목록은 편집 검사 목록을 참조하세요.

  • 문법, 스타일, 간결성, 기술 정확도에 대한 교정
  • 대상 버전에 대한 예제가 계속 적용되는지 확인합니다.
  • 미리 보기 렌더링 확인
  • 메타데이터 확인 - ms.date, ms.assetid 제거, 필수 필드 확인
  • markdown 정확성 유효성 검사
    • 콘텐츠별 서식 규칙에 대한 스타일 가이드를 참조하세요.
  • 다음과 같이 예제를 다시 구성합니다.
    • 소개 단락
    • 코드 및 출력
    • 코드에 대한 자세한 설명(필요한 경우)
  • 하이퍼링크의 정확도 확인
    • TechNet/MSDN 링크 바꾸기 또는 제거
    • 대상에 대한 최소 리디렉션 수 확인
    • HTTPS 확인
    • 올바른 링크 유형
      • 로컬 파일에 대한 파일 링크
      • 문서 세트 외부의 파일에 대한 URL 링크
    • URL에서 로캘 제거
    • learn.microsoft.com로 가리키는 URL을 간소화하기
  • 버전이 지정된 콘텐츠가 모든 버전에서 올바른지 확인

분기 병합 프로세스

main 분기는 live에 병합해야 하는 유일한 분기입니다. 단명한 (작업) 분기에서 병합된 내용은 최종 병합하기 전에 main에 아우러져야 합니다.

병합 시작/끝 릴리스 브랜치 메인 라이브
working-branch 커밋 합치기 및 병합 커밋 합치기 및 병합 허용되지 않음
릴리스 브랜치 — 병합 허용되지 않음
메인 리베이스 — 병합

PR 병합 체크리스트

  • 콘텐츠 검토 완료
  • 변경에 대한 대상 분기의 올바름을 확인하십시오.
  • 병합 충돌 없음
  • 모든 유효성 검사 및 빌드 단계 통과
    • 경고 및 제안을 수정해야 합니다(예외에 대한 참고 사항 참조).
    • 끊어진 링크 없음
    • 검사 목록 작업이 실행되고 전달됨
    • 권한 부여 확인이 트리거된 경우 전달됩니다.
  • 테이블에 따라 병합

비고

다음 경고는 무시할 수 있습니다.

Can't find service name for `<version>/<modulepath>/About/About.md`

Metadata with following name(s) are not allowed to be set in YAML header, or as file level
metadata in docfx.json, or as global metadata in docfx.json: `locale`. They are generated by
Docs platform, so the values set in these 3 places will be ignored. Please remove them from all
3 places to resolve the warning.

PR이 병합되면 대상 분기의 HEAD가 변경됩니다. 이전 HEAD를 기반으로 한 열려 있는 모든 PR은 이제 오래되었습니다. 유지 관리자가 병합 경고를 재정의하고 GitHub에서 오래된 PR을 병합하는 데 필요한 권한이 있습니다. 이전에 병합된 PR이 동일한 파일을 건드리지 않은 경우 오래된 PR을 병합해도 안전합니다.

PR을 업데이트하려면 분기 업데이트 단추를 선택합니다. 다시베이스 옵션을 사용하여 업데이트를 선택합니다. 자세한 내용은 풀 리퀘스트 브랜치 업데이트를 참조하세요.

라이브에 게시하기

정기적으로 main 브랜치에 누적된 변경 내용을 라이브 웹 사이트에 게시해야 합니다.

  • 브랜치 main 는 매주 평일 오후 3시 PST에 live로 병합됩니다.
  • 중요한 변경 후 main 브랜치를 live로 병합해야 합니다.
    • 50개 이상의 파일 변경 내용
    • 릴리스 분기를 병합한 후
    • 리포지토리 또는 문서 세트 구성 변경(docfx.json, OPS 구성, 빌드 스크립트 등)
    • 리디렉션 파일의 변경 내용
    • TOC 변경 내용
    • "프로젝트" 분기를 병합한 후(콘텐츠 다시 정렬, 대량 업데이트 등)