[Github] 깃허브 이슈, PR 템플릿 등록하기

들어가며

이번에는 Organization에서 리파지토리마다 공통된 깃허브 이슈, PR 템플릿을 등록하는 방법에 대해서 정리해보고자 한다. 우리가 흔히 만드는 `.github/ISSUE_TEMPLATE/template.md` 이런식으로 마크다운 형식이 아닌, `yml` 형태로 만드는 방법에 대해서 알아보자. 그렇게 되면,, 개인적으로는 깔끔하게 느껴져서 좋다 ... !! ㅎㅎ 

---

이슈 템플릿

나는 일단 전체 Organization에 공통된 이슈 템플릿을 설정해주기 위해서 Organization에 `.github` 리파지토리를 만들었다. 

그리고 그 안에 `.github/ISSUE_TEMPLATE` 폴더를 만들고 안에 Feature, Refactor, Bug 관련 yml 형태의 이슈 템플릿을 만들었다. 그리고 아래는 내가 예시이다 ! 

Feature 템플릿 (feature.yml)

name: "✨ Feature"
description: "새로운 기능 추가"
title: "[FEAT] "
labels: ["feature"]
body:
  - type: textarea
    attributes:
      label: 📄 설명
      description: 새로운 기능에 대한 설명을 작성해 주세요.
      placeholder: 자세히 적을수록 좋습니다!
    validations:
      required: true
  - type: textarea
    attributes:
      label: ✅ 작업할 내용
      description: 할 일을 체크박스 형태로 작성해주세요.
      placeholder: 최대한 세분화 해서 적어주세요!
    validations:
      required: true
  - type: textarea
    attributes:
      label: 🙋🏻 참고 자료
      description: 참고 자료가 있다면 작성해 주세요.

Refactor 템플릿 (refactor.yml) 

name: ♻️ Refactor
description: 코드 구조 개선, 성능 최적화, 유지보수성 향상 등을 위한 요청
title: "[REFACTOR] "
labels: ["refactor"]
body:
  - type: textarea
    id: context
    attributes:
      label: 리팩토링 필요 배경
      description: 리팩토링이 필요한 이유와 현재 상황을 설명해주세요.
      placeholder: 예) 코드 중복이 많아 유지보수성이 떨어짐, 성능 저하 발생
    validations:
      required: true

  - type: textarea
    id: scope
    attributes:
      label: 리팩토링 범위
      description: 어떤 부분(모듈/함수/파일)을 리팩토링하려고 하는지 구체적으로 작성해주세요.
      placeholder: 예) user_service.py 내 데이터 처리 로직
    validations:
      required: true

Bug 템플릿 (bug.yml) 

name: 🐛 Bug
description: 발견한 버그에 대해 알려주세요.
title: "[BUG] "
labels: ["bug"]
body:
  - type: textarea
    id: description
    attributes:
      label: 문제 설명
      description: 발생한 문제를 최대한 구체적으로 적어주세요.
    validations:
      required: true

---

PR 템플릿 

그리고 PR 템플릿 역시, 같은 방법으로 만들어주면 된다. 아, 근데 PR 템플릿은 마크다운 형태로 만들어주었다. 

## 🪺 PR 개요
- 변경된 내용을 간단하게 설명해주세요.

## 🌱 Issue Number
- 관련 이슈 번호를 적어주세요. (예: #123)

## ✨ 변경 사항
- [ ] 기능 추가
- [ ] 버그 수정
- [ ] 리팩토링
- [ ] 문서 업데이트

## 🙏 To Reviewers

---

참고 

yml로 깃허브 템플릿 제작하기