[GitHub] PR 기본 템플릿 지정하기

이준영·2023년 8월 14일
0

🚀 GitHub

목록 보기
4/4
post-thumbnail

PR(Pull Requests) 기본 템플릿 지정

우리는 코드를 작성하고 원격에 push 한 이후, PR을 보낼 때 이러한 화면을 마주하게 됩니다.


PR 템플릿 예시

### PR 타입(하나 이상의 PR 타입을 선택해주세요)
- [x] 기능 추가
- [ ] 기능 삭제
- [ ] 버그 수정
- [ ] 의존성, 환경 변수, 빌드 관련 코드 업데이트

### 반영 브랜치
ex) feat/login -> dev

### 변경 사항
ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.

### 테스트 결과
ex) 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린샷, GIF, 혹은 라이브 데모가 가능하도록 샘플API를 첨부할 수도 있습니다.

PR을 위와 같은 양식으로 보내는 경우에 PR을 보낼 때마다 일일이 다 작성하거나 적어둔 글을 복사&붙여넣기 해야하는 번거로움이 생기는데요, 이 경우 PULL_REQUEST_TEMPLATE.md 파일을 추가함으로써 개선할 수 있습니다.

PULL_REQUEST_TEMPLATE.md

PULL_REQUEST_TEMPLATE.md 파일은 3가지 방법으로 추가가 가능한데요,

  1. root 폴더에 생성하거나

  2. docs/ 폴더에 생성하거나

  3. .github/ 폴더에 생성함으로써 PR의 기본 템플릿을 지정할 수 있습니다. (issue 템플릿도 .github 폴더에 저장되기에 해당 방법을 선호)


템플릿 추가하는것도 파일을 레포지토리에 추가하는 작업이기에 커밋을 해주어야 합니다.
커밋 메세지 예시
	Docs: Add PullRequests Template
    
    PR을 보낼때 적용되는 기본 템플릿 추가

실제 적용 화면 예시

적용 이후에는 이렇게 PR을 보낼 때 기본 템플릿이 적용되는 것을 확인할 수 있습니다 🔥🔥

profile
작은 걸음이라도 꾸준히

0개의 댓글