[Git] GitLab MR Template 만들기

예구·2023년 5월 7일

1. template을 만드는 이유

가장 큰 이유는 협업이다.
많은 개발자들이 각자만의 문서 작성 스타일이 있고, 이를 전달하다보면 빼먹는 것도 있고 소통의 문제가 발생할 수도 있다.
따라서 협업에 필수적으로 사용되는 요소들에 공통된 양식으로 작성하면 가독성도 좋아지고, 코드리뷰를 하기에도 수월해질 것이다.

2. GitLab template 만들기

2.1. `.gitlab`에 템플릿 디렉토리 및 md 파일 생성하기

본인의 repository root 경로에 .gitlab 디렉토리를 생성
gitlab/issue_templates/ 내부 md 파일은 모두 issue 템플릿으로 활용됨
.gitlab/merge_request_templates/ 내부 md 파일은 mr 템플릿으로 활용됨

2.2. 템플릿 파일(md) 작성

본인의 팀이나 프로젝트 특성에 맞게 필요한 내용을 모두 취합한 후 적절하게 작성
아래의 template은 실제로 현재 프로젝트에서 사용하고 있는 template임

default.md

가장 많이 사용하는 template (사실 이것만 사용하고 있다..)

- 제목 : feat(지라 코드): 기능명
  ex) feat(지라 코드): login
  (확인 후 지워주세요)

## 🔘Part

- [ ] FE

- [ ] BE

- [ ] Other

  <br/>

## 🔎 작업 내용

- 기능에서 어떤 부분이

- 구현되었는지 설명해주세요

  <br/>

## 이미지 첨부

<img src="파일주소" width="30%" height="30%"/>

<br/>

## 🔧 앞으로의 과제

- 내일 할 일을

- 적어주세요

  <br/>

## ➕ 지라 링크

- [지라번호-숫자](지라주소)

<br/>

bug_request.md

버그에 대해 작성하는 template

- 제목 : modify(지라 코드): 기능명
ex) bug(지라 코드): login#1
(확인 후 지워주세요)

## ❌오류 내용
  - 오류 내용에 대해서
  - 설명해주세요
<br/>

## 📄 기능 상세 설명
  - 기능에서 어떤 부분이
  - 구현되어야 하는지 설명해 주세요
<br/>

 ## ➕ 지라 링크
 - [지라번호-숫자](지라주소)

<br/>

modify_request.md

변경사항에 대해 작성하는 template

- 제목 : modify(지라 코드): 기능명
  ex) modify(지라 코드): login#1
  (확인 후 지워주세요)

## 🔧 변경 사항

- 변경사항에 대해

- 설명해주세요

  <br/>

 ## ➕ 지라 링크
 - [지라번호-숫자](지라주소)

<br/>