10/27 TIL | 문서화는 나의 힘! Github Issue Template을 활용하여 문서 손쉽게 작성하기.

오늘부터 코딩 도장 문제를 풀기 전에 어떻게 문제를 풀 것인지 글로 생각을 정리하고 문제를 푸는 것으로 새로운 가이드가 주어졌다! 가이드에서는 README.md 파일에 작성하라고 되어있었지만, 매번 README.md 파일 생성, 안에 들어가는 템플릿 복사 붙여 넣기 등 부수적인 작업을 해야 하는 게 귀찮았다... 이런 거는 어떻게든 자동화하고 싶은 맴..^^ㅎㅎ

그래서 깃허브 레포지토리 기능 중 이슈를 적극 활용해봐야겠다 싶었고, 오늘 코딩 도장에 일찍 출근한 김에 이슈 템플릿을 만들어보았다! 동기들에게 공유를 했더니 옆자리 쥬쥬가 너무 좋다고 TIL로도 공유해달라고 해서 한번 작성해본다!

---

이슈 템플릿 작성 방법

1. 템플릿을 만들고자 하는 레포지토리의 Settings를 클릭한다.

2. Settings > Features > Issues의 Set up templates 버튼을 클릭한다.

3. Add template을 클릭한다.
(참고로 나의 경우 이미 템플릿이 만들어진 상황이라 목록에 💡 How to solve it?이 존재하는 것인데, 원래는 설정을 한 번도 안 했다면 아무것도 없는 것이 맞다!)

4. Bug, Feature report의 경우 Github에서 기본적으로 제공해주는 템플릿이고, 커스텀을 하기 위해서는 Custom template 클릭한다!

5. 그러면 Custom template이 목록에 추가된다. Preview and edit 버튼을 클릭한다.

6. 그럼 아래 사진과 같이 템플릿을 미리 볼 수 있고, 수정을 하려면 연필 모양 아이콘을 클릭한다.

7. 이제 본격적으로 템플릿을 작성해보자!
[필수]
1️⃣ Template name: 해당 템플릿의 제목을 입력한다.
2️⃣ About: 해당 템플릿이 무슨 템플릿인지 설명을 입력한다.
3️⃣ Template content: 템플릿 양식을 작성한다.
→ 이때 마크다운 문법을 활용하여 작성한다!

[선택(Optional additional items)]
4️⃣ Issue default title: 이슈를 생성할 때마다 함께 입력될 디폴트 제목을 입력한다.
→ 나의 경우엔 항상 작성하는 제목의 양식을 적어놓았다. ex. 20221027 코딩 도장 : 모의고사
5️⃣ Assignees: 해당 이슈의 담당자를 지정한다.
→ 나의 경우엔 혼자 사용하는 레포지토리이기 때문에 따로 설정하지 않았다. 여럿이서 사용하는 레포지토리라면 유용하게 쓰일 기능!
6️⃣ Labels: 라벨을 설정한다.
→ 나의 경우엔 이슈와 PR마다 라벨을 활용하여 필터링하기 때문에 how to solve라는 라벨을 추가하였다!

8. 템플릿을 다 작성했다면 Propose changes 버튼을 클릭한다.

9. 그러면 커밋 메시지를 입력하는 창이 뜨고, 커밋 메시지를 작성한 후 Commit changes 버튼을 클릭하면 된다.

10. 그렇게 하면 레포지토리에 .github 폴더에 ISSUE_TEMPLATE이라는 폴더가 생성되고 그 안에 방금 작성한 템플릿 양식이 들어가 있다.

11. 방금 만든 템플릿을 활용해보자! 이슈 페이지에서 New issue 버튼을 클릭한다.

12. 그럼 바로 내가 아까 작성한 템플릿이 목록에 보이고 Get started를 클릭한다.
(참고로 템플릿 말고 빈 이슈를 만들고 싶다면, 하단에 Open a blank issue를 클릭하면 된다!)

13. 그럼 내가 설정해놓은 양식들이 들어가 있는 이슈 에디터를 만날 수 있다!! 짝짝짝 👏

그렇게 해서 완성된 나의 이슈 템플릿은 작성되면 아래와 같은 화면이다! 마크 다운 문법을 활용해서 How to solve it? 작성 가이드도 템플릿에 추가하였다! 덕분에 가이드 페이지를 따로 들어가서 참고할 필요 없이 이 이슈를 작성하면서 한큐에 해결할 수 있다!! 👍🏻

---

💡 추가 Tip: 이슈에 커밋, PR 연동하기!

추가로 한 가지 팁을 더 말해보자면, 커밋을 하거나 PR을 작성할 때 방금 만든 Issue를 연결할 수 있다. 이슈를 생성하면 생기는 이슈 번호(#ISSUE_NUMBER)가 있다! (아래 사진은 54번!)

그 이슈 번호를 커밋 메시지 또는 PR 작성 시 본문에 같이 입력하면 Issue에 해당 커밋과 PR이 연동된다! 이슈에 위와 같이 해당 작업들에 대한 내용들이 추가된 것을 확인할 수 있다!

p.s 이슈 템플릿을 등록할 수 있다면 PR 템플릿도 작성할 수 있다! 같은 방식으로 PR 템플릿도 작성해서 슬기로운 Github 생활을 즐길 수 있도록 하자!!🌹

---

평생을 정리 + 기록충으로 살아오면서 이렇게 문서화하고 기능들 활용하는 걸 너무 좋아하는데, 내 작업에도, 그리고 동기들 작업에도 도움이 될 만한 내용을 공유한 거 같아 뿌듯하다! 앞으로도 기록을 충실히 하여 좋은 팁이 있다면 블로그에 공유해야겠다!💪