[Git] GitLab Issue, MR Template 만들기

GitLab Issue, MR Template 만들기

들어가기 전에..template을 왜 만드는가 ? 🤷🏻‍♀️

• gitlab에서는 협업하기 위해서 여러가지 기능을 제공하고 있습니다.
  많은 개발자들이 함께 일하다보면 각자만의 문서 작성 스타일이 다르고 전달하려는 내용도 빼먹을 수 있다보니 공통적으로 한번에 체크해줄만한 양식이 있으면 좋을 것 같지 않나요?
  특히나 issue나 mr처럼 협업에 필수적으로 사용되는 요소들에 공통된 양식으로 작성하면 가독성도 좋아지고, 코드리뷰를 하기도 수월해질 것입니다.

• 기타 gitlab 협업을 더 잘하는 내용에 대해 잘 정리해 놓은 내용들을 남겨봅니다.
  https://insight.infograb.net/blog/2020/11/18/better-codereview-with-gitlab/
  http://developer.gaeasoft.co.kr/development-guide/workflow/gitlab-workflow-guide/

gitlab issue template 만들기

본 내용은 아래의 GitLab Description templates에 기반한 내용입니다.

1️⃣ 단계 .gitlab에 템플릿 디렉토리 및 md 파일 생성하기

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

2️⃣ 단계 템플릿 파일(md)을 작성합니다.

• 본인의 팀이나 프로젝트 특성에 맞게 필요한 내용을 모두 취합한 후 적절하게 작성해주시면 됩니다.

아래는 임의로 작성해본 template 예시입니다.

feature_request.md

# Feature Request
- Part
  - [ ] FE
  - [ ] BE
  - [ ] Data Preprocessiong
- 기능 상세 설명
  - 기능에서 어떤 부분이 구현되어야 하는 지 설명해주세요
- Deadline
  - 마감 기한을 설정해주세요

default.md

## 어떤 이유로 MR를 하셨나요?
- [ ] feature 병합(feature issue #를 남겨주세요)
- [ ] 버그 수정(아래에 issue #를 남겨주세요)
- [ ] 코드 개선
- [ ] 기타(아래에 자세한 내용 기입해주세요)

## 스크린샷 및 세부 내용 - 왜 해당 MR이 필요한지 자세하게 설명해주세요
- 세부사항을 항목으로 설명해주세요

## MR하기 전에 확인해주세요
- [ ] local code lint 검사를 진행하셨나요?
- [ ] loca ci test를 진행하셨나요 ?

## relavant issue number
- 관련된 이슈 넘버가 있으면 이곳에 기입해주세요

3️⃣ 단계 main branch에 push 후, 템플릿을 적용해 issue 또는 mr를 작성합니다.