[2주차] 내일배움캠프 Spring Java - AI 활용 비즈니스 프로젝트 DAY3 - Issues & PR Template 설정하기

 

팀원들과 각자 맡은 domain에 대한 Controller을 구현하기로 했다. 그래서 Github에서 각자 Issues와 PR을 작성하는데, 뒤늦게 템플릿을 미리 적용하지 않았다는 것을 깨달았다.

 

Issues와 PR은 프로젝트 과정에서 서로의 작업 내용을 확인할 수 있도록 팀원들이 각자 작성하는 문서이므로, 공통 양식을 정해두면 좋다. 공통 양식을 하나하나 추가하는 것은 불필요한 작업이기 때문에 템플릿을 적용하는 것이 유용하다. 따라서 아래와 같이 템플릿을 적용하려고 한다.

Issues Template

이슈 템플릿을 적용하는 방법은 2가지가 있다.

 

1. github/ISSUE_TEMPLATE 디렉터리에 .md 파일 추가
2. Github 설정

 

요약

📌 리포지토리 > Settings > Issues > Set up templates 클릭

1. 리포지토리의 Settings 탭으로 이동
- GitHub 저장소 상단의 ⚙️ Settings 클릭

2. 좌측 메뉴에서 Issues 섹션 찾기
- Features 아래 Issues 항목이 활성화되어 있어야 함.

3. Set up templates 버튼 클릭
- Set up templates를 클릭하면 이슈 템플릿 편집 화면으로 이동

4. 템플릿 추가
- Bug report, Feature request 등 기본 템플릿 선택 가능
- 또는 Create a custom template 클릭 후 직접 작성 가능

5. 템플릿 저장 (Commit changes)
- Propose changes → Commit changes 버튼을 눌러 저장

 

Github에서 설정하는 것이 편하기 때문에 이 방법으로 진행한다.

 

 

먼저 Github에서 작업 진행 중인 프로젝트의 Repository에 접속한다. 그리고 Setting를 클릭한다.

 

 

General에서 스크롤을 아래로 내려서 Issues의 Set up templates 버튼을 클릭한다.

 

 

Add template: select를 클릭하고 Custom template를 클릭한다.

 

 

템플릿 편집 화면에서 템플릿에 대한 내용을 작성하고 Propose changes 버튼을 눌러 저장한다. Commit message를 작성하고 Commit changes 버튼을 클릭하면 된다.

 

 

.github/ISSUE_TEMPLATE 디렉터리에 custom.md 파일이 추가된 것을 확인할 수 있다. 이제 New issue 버튼을 클릭하면 템플릿에 설정한 대로 자동 생성이 된다.

PR Template

PR 템플릿을 적용하는 방법은 다음과 같다.

 

요약

1. 리포지토리의 Code 탭으로 이동

2. 상단의 "Add file" 버튼 클릭 (Add file > Create new file)

3. 파일 이름 입력
- .github/PULL_REQUEST_TEMPLATE.md

4. PR 템플릿 내용 작성

5. 파일 저장 (Commit changes)
- Commit new file 버튼을 눌러 저장

 

마찬가지로 Github에서 설정한다.

 

 

프로젝트 Repository의 Code 탭으로 이동해서 Add file 버튼과 Create new file 버튼을 클릭한다.

 

.github/PULL_REQUEST_TEMPLATE.md

 

파일명에 .github/PULL_REQUEST_TEMPLATE.md를 입력한다.

 

// .github/PULL_REQUEST_TEMPLATE.md
- (구현 내용)

## ✅ 작업 내용
- [ ]

 

그리고 정해둔 PR 템플릿 내용을 작성한다.

 

 

Commit changes 버튼을 클릭하여 파일을 저장하면 PR을 작성할 때마다 템플릿 내용이 자동으로 설정된다.