템플릿을 사용하여 끌어오기 요청 설명 개선
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
좋은 끌어오기 요청 설명을 작성하는 것은 검토자가 코드를 검토할 때 예상되는 사항을 알 수 있는 좋은 방법입니다. 또한 테스트, 단위 테스트 추가, 설명서 업데이트 등 모든 변경 사항에 대해 수행해야 하는 작업을 추적하는 데 도움이 되는 좋은 방법입니다. 끌어오기 요청 템플릿은 개발자가 organization 표준을 충족하는 훌륭한 끌어오기 요청 설명을 만드는 데 도움이 될 수 있습니다.
이 문서에서는 끌어오기 요청 템플릿을 시작하는 방법을 보여 줍니다.
참고
끌어오기 요청 템플릿은 지침을 제공할 수 있지만 권고 전용입니다. 분기 정책을 사용하여 기본 같은 주요 분기에 대한 끌어오기 요청 필요, 성공적인 빌드 필요 및 필요한 검토자 적용과 같은 모범 사례를 적용합니다. 자세한 내용은 분기 정책을 참조하세요.
끌어오기 요청 템플릿이란?
끌어오기 요청 템플릿은 끌어오기 요청을 만들 때 끌어오기 요청 설명에 추가되는 Markdown 텍스트를 포함하는 파일입니다.
Thank you for your contribution to the Fabrikam Fiber repo.
Before submitting this PR, please make sure:
- [ ] Your code builds clean without any errors or warnings
- [ ] You are using approved terminology
- [ ] You have added unit tests
Azure Repos 다음과 같은 유형의 끌어오기 요청 템플릿을 만들 수 있습니다.
- 분기별 끌어오기 요청 템플릿으로 재정의되지 않는 한 리포지토리의 모든 새 끌어오기 요청에 자동으로 적용되는 기본 끌어오기 요청 템플릿
- 특정 분기 를 대상으로 하는 끌어오기 요청에 자동으로 적용되는 분기별 끌어오기 요청 템플릿
- 끌어오기 요청 작성자가 선택적으로 추가할 수 있는 추가 끌어오기 요청 템플릿
끌어오기 요청 템플릿의 형식은 다음 섹션에서 설명한 대로 파일 이름 및 폴더 위치에 따라 결정됩니다. 파일 이름과 폴더 위치는 대/소문자를 구분하지 않지만 리포지토리의 기본 분기 있어야 합니다.
참고
모든 끌어오기 요청 템플릿 파일은 리포지토리의 기본 분기(일반적으로 기본)에 있어야 합니다. 기본 분기 끌어오기 요청 템플릿 파일만 사용됩니다.
기본 끌어오기 요청 템플릿
새 끌어오기 요청이 만들어지면 기본 끌어오기 요청 템플릿이 설명 필드에 자동으로 적용됩니다. 기본 끌어오기 요청 템플릿을 사용하여 리포지토리를 구성하려면 라는 pull_request_template.md 파일을 만들거나 pull_request_template.txt 다음 폴더 중 하나에 리포지토리의 기본 분기 저장합니다.
- 리포지토리의 루트 폴더에 포함된 라는
.azuredevops폴더 - 리포지토리의 루트 폴더에 포함된 라는
.vsts폴더 - 리포지토리의 루트 폴더에 포함된 라는
docs폴더 - 리포지토리의 루트 폴더
끌어오기 요청 템플릿을 저장하는 위치에 유연성을 제공하기 위해 여러 위치가 제공됩니다. 끌어오기 요청을 만들 때 Azure Repos 지정된 순서대로 지정된 폴더를 검색하고 찾은 첫 번째 기본 끌어오기 요청 템플릿을 사용합니다.
분기별 끌어오기 요청 템플릿이 적용되지 않는 한 리포지토리에서 새 끌어오기 요청을 만들 때 기본 끌어오기 요청 템플릿의 내용을 사용하여 끌어오기 요청의 설명 필드를 미리 채웁니다.
템플릿 추가 드롭다운에서 선택하여 원하는 경우 이 설명을 편집하거나 추가하고 추가 끌어오기 요청템플릿을 추가할 수 있습니다.
참고
기본 또는 분기별 끌어오기 요청 템플릿이 자동으로 적용되면 일반적으로 기본 설명에 사용되는 표준 커밋 메시지를 대체합니다. 커밋 메시지 추가를 선택하여 다시 추가할 수 있습니다.
분기별 끌어오기 요청 템플릿
특정 분기를 대상으로 하는 끌어오기 요청에 대해 분기별 끌어오기 요청 템플릿을 구성할 수 있습니다. 분기별 끌어오기 요청 템플릿을 사용하여 리포지토리를 구성하려면 분기의 이름을 따서 명명된 .txt 또는 .md 파일을 만듭니다. 이름은 , , devrelease또는 feature와 같은 main분기 이름의 첫 번째 수준과 일치해야 합니다. 각 분기별 끌어오기 요청 템플릿은 끌어오기 요청이 분기 또는 그 아래에 포함된 분기를 대상으로 할 때마다 적용됩니다. 예를 들어 끌어오기 요청이 분기 또는 분기 feature/* 를 대상으로 하는 경우 라는 feature.md 끌어오기 요청 템플릿이 feature 적용됩니다.
분기별 끌어오기 요청 템플릿은 폴더 계층 구조를 pull_request_template/branches/사용하여 리포지토리의 기본 분기 저장해야 합니다. 이러한 폴더는 리포지토리의 다음 폴더 중 하나를 기반으로 해야 합니다.
- 리포지토리의 루트 폴더에 포함된 라는
.azuredevops폴더 - 리포지토리의 루트 폴더에 포함된 라는
.vsts폴더 - 리포지토리의 루트 폴더에 포함된 라는
docs폴더 - 리포지토리의 루트 폴더
예를 들어 분기에 대한 모든 끌어오기 요청에 적용해야 하는 분기별 끌어오기 요청 템플릿의 dev 이름은 dev.md 또는 dev.txt 이며 다음 위치 중 하나에 배치됩니다.
<repository root>/.azuredevops/pull_request_template/branches/<repository root>/.vsts/pull_request_template/branches/<repository root>/docs/pull_request_template/branches/<repository root>/pull_request_template/branches/
기본 끌어오기 요청 템플릿과 마찬가지로 분기별 끌어오기 요청 템플릿을 저장하는 위치에 유연성을 제공하기 위해 여러 위치가 제공됩니다. 끌어오기 요청을 만들 때 Azure Repos 지정된 폴더를 지정된 순서대로 검색하여 분기 특정 끌어오기 요청 템플릿을 검색하고 분기 이름과 일치하는 첫 번째 폴더를 사용합니다. 분기별 끌어오기 요청 템플릿을 찾을 수 없는 경우 Azure Repos 이전 기본 끌어오기 요청 템플릿 섹션에 설명된 대로 기본 끌어오기 요청 템플릿을 검색합니다.
추가 끌어오기 요청 템플릿
기본 및 분기별 끌어오기 요청 템플릿 외에도 추가 끌어오기 요청 템플릿을 구성할 수 있습니다. 기본 분기 다음 폴더 중 하나에 있는 또는 .txt 파일일 .md 수 있습니다.
<repository root>/.azuredevops/pull_request_template/<repository root>/.vsts/pull_request_template/<repository root>/docs/pull_request_template/<repository root>/pull_request_template/
끌어오기 요청을 만들 때 템플릿 추가 드롭다운에서 선택하여 사용 가능한 끌어오기 요청 템플릿을 추가할 수 있습니다. 드롭다운의 이름은 템플릿의 파일 이름을 기반으로 합니다.
다음 예제에서는 세 가지 템플릿이 나열됩니다.
-
dev.md- 파일 이름 다음에 나열된 기본 메시지로 표시된 대로 이 끌어오기 요청에 기본적으로 적용된 분기별 템플릿입니다. -
additional.md- 추가 템플릿입니다. -
pull_request_template.md- 일반적으로 기본 템플릿이지만 이 끌어오기 요청의 분기별 템플릿에 의해 재정의dev.md되었습니다. 기본적으로 추가되지는 않았지만 목록에서 선택하여 적용할 수 있습니다.
원하는 추가 템플릿의 이름을 선택하여 현재 끌어오기 요청 설명에 콘텐츠를 추가합니다.
참고
쿼리 문자열에 를 추가하여 일치하는 기본 또는 분기별 끌어오기 요청을 재정의하도록 끌어오기 요청 템플릿을 ?template=name.md 지정할 수 있습니다.