Git Hub - Discussions Template 만들기

git/GitHub

쿠키오빠 2024. 11. 27. 09:06

Git hub Issue 템플릿 만드는 것과는 다르게 Discussions 템플릿은 꽤 까다로운 편이다.

이거는 Issue 템플릿 만들 때 보다 시간이 배로 들었다...

이것 또한 까먹지 않기 위해 기록을 날려주겠다..

간단한 정리를 해보자면 Discussions Template이란 Github에서 지원하는 팀 원들간의 자유로운 소통 공간이다.

< Discussions 특징 >

- 주제를 기반으로 논의 스레드 생성

- 질문/답변 형태로 활용 가능

- 주제별로 카테고리 지정 가능 (예: 아이디어 , 질문 , 일반 논의)

- 참여자의 의견을 수집하고 커뮤니티와 소통하는 데 중점

이슈 템플릿과 마찬가지로 Discussions 도 템플릿(정해진 작성 틀)이 없다면 가독성이 좋지 못할 것이다.

말 그대로 자유로운 소통 공간이지만 틀을 유지하지 않고 작성하고, 그게 누적된다면 추후엔 자유롭지 못하지 않을까?

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

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

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

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

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

ex) DISCUSSION_TEMPLATE / custom.md

● DISCUSSION_TEMPLATE → 디렉토리

● DailyScrum.yml → 파일명

여기까진 Issue 템플릿 만드는 방법과 동일하다.

하지만 가장 중요한 사실은 Discussions 템플릿을 작성하기 위해서는 yml (야믈) 파일로 만들어야 한다는 것...

어디서 들어본 적은 있어도 사용해 본적은 없었다. (html을 처음 접했을 때의 기분이었다.)

또한 레파지토리의 (★중요)파일 명과 템플릿 명이 동일해야 적용이 된다. (쩌~아래에서 확인)

③ .github → DISCUSSION_TEMPLATE 디렉터리를 거쳐, 작성할 템플릿 파일 클릭

(아래 3개는 이미 구현했으므로 무시해주3~)

④ 편집버튼 클릭

⑤ yml 형식으로 코드 작성 후 commit!

yml 형식으로 템플릿 작성이 완료 되었다.

① Discussions → 연필 모양 클릭하여 편집하기

원래는 카테고리에 디폴트로 여러가지가 있었는데 나는 필요한 것으로만 추렸다.

② ★ Category name 란에 레파지토리에서 만든 yml 파일의 파일명과 동일하게 설정! ★

① New discussion 클릭

② Get Stared 클릭

③ yml 파일에 구성해 놓았던 템플릿 구현 확인!

yml 파일 작성 시 주의사항으로는 들여쓰기가 가장 중요한 거 같다.

문법 자체도 생소한데, 칸 하나 안 맞췄다고 코드 전체에 에러가 먹힐수도 있다는 걸 뼈저리게 느꼇다.

그래서 어느정도 작성 후.... gpt 의 도움을 조금 받았따...

코드 작성 후, 간단한 수정은 gpt에 맡기는 것도 좋아 보인다. 아니 좋다.