Git Hub - Issues Template 만들기

Issues 란 프로젝트에서 발생한 버그 , 작업 항목 , 개선 요청을 기록하고 추적하기 위한 도구이다.

작업 단위로 관리되고, 팀원간에 토론하고나 진행 상황을 공유할 수 있는 기능이다.

 

예를 들어 프로젝트 시 , 개인이 맡은 기능을 구현하는데 에러가 발생했을 때 Issue에 작성한다.

 

템플릿 없이 작성하려면 아래와 같이 틀이 적용되지 않은 형식으로 작성하게 되는데,

글이 쌓이면 가독성이 좋지 않아, 그간 작성한 내용이 쓸모가 없어질 것이다.

---

▷ Repositoriese 구성하기

 

① 팀원간 적용할 Repositories 를 구성한다.

 

② Create new file을 클릭하여 새 파일을 만든다.

파일 만들 때 해당 레파지토리에 Pull requests나 Discussions 템플릿을 추가 작성해야 할 수도 있으니,

Issue용  디렉토리를 따로 구성하여 만드는 것이 좋다. 

 

보통 new file에 입력 시  /  로 디렉토리를 구분한다.

ex) ISSUE_TEMPLATE / custom.md

● ISSUE_TEMPLATE →  디렉토리

● custom.md  → 파일명

---

▷ Issue 템플릿 작성하기

 

 

해당 레파지토리 들어가서

① Settings → Features → Set up templates 클릭

 

② 원하는 유형의 템플릿 선택

(위에는 이미 구현해 놓은 이슈 템플릿들)

 

③ 템플릿 이름과 내용을 정의할 수 있고, Issue default title은 이슈 생성 시 자동 적용 항목이다.

 

나는 이런식으로 작성해 보았다.

 

 

④ propose changes  → commit changes 클릭

 

⑤ commit 후, 레파지토리 확인해보면 업데이트가 돼있다.

 

 

그간 SQDL 시험 준비로 블로그를 작성하지 못했다. 핑계같아 보이지만 진짜다! (시험은 망한 것 같다.)

 

앞으로는 그날 그날 느낀 게 있다면 바로바로 기록하겠3~~

 

Issue 템플릿 작성하는데 꽤 오랜 시간이 걸렸다.

익숙해 지면 쉽겠지만 익숙해 지기까지 시간이 걸릴 것이 예상되므로 기록을 남기고, 앞으로 시간을 단축시킬 예정!!