이번에는 이슈 템플릿이랑 만들어 보려고 한다!
사실 지난 프로젝트에서도 GitLab에서 사용하긴 했지만.. 그땐 팀원이 다 만들어준 상태에서 이용했었는데 이번 프로젝트에서는 내가 도입해보려고 한다.
누군가에게 도움이 될까 싶어서 양식/예시도 올려뒀다.
✏️ 라벨 만들기
라벨은 기본적으로 주어져 있어서 건들지 않아도 사용할 수 있긴 하다.
나는 우리 프로젝트에 맞게 수정하고 싶어서 라벨부터 바꿔줬다.
먼저 리포지토리에 들어가서 Labels를 들어가면 리포지토리의 라벨 목록이 뜬다.
기본적으로 여러 개 있었지만 나는 아래와 같이 수정했다!
타입이 따로 있긴 하지만 타입은 커스텀이 안돼서 타입을 안쓰고 라벨에서 관리하는 거 같다.
일단 필요하다고 생각되는 것들 만들어봤는데 프로젝트 하다보면 수정할지는 모르겠다.
이렇게 라벨로 타입을 관리하기도 하고 에픽/기능 중심적으로 관리하기도 한다.
vercel/next.js 깃허브를 봤을 때는 create-next-app, CSS, Error Handling, Pages Router, bug 등 기능 중심적이면서도 살짝 섞여있는 것 같다.
라벨은 하나만 선택할 수 있는 게 아니라 다중선택이기 때문에 프로젝트에 맞게 혼용해서 써도 되는 거 같다.
✏️ 이슈 템플릿 만들기
리포지토리 Settings로 가서 스크롤을 살짝만 내리면 이게 뜬다.
Set up templates를 누르자.
이제 여기서 이슈 템플릿을 작성하면 된다.
내용 뿐만 아니라 기본 제목, Assignee, Label도 지정할 수 있다.
이슈 템플릿 내용은 팀에 맞게 작성하면 된다.
나 같은 경우는 아래와 같이 세 개의 이슈 템플릿을 만들었다.
| ✨ Feature | 🐛 Bug | ❓ Question |
| 새로운 기능 추가, 기존 기능 개선을 제안할 때 사용 | 발생한 버그를 제보할 때 사용 | 궁금한 점이나 논의가 필요한 내용을 남길 때 사용 |
| ## 📑 기능 설명 ## ✅ 작업할 내용 - [ ] 컴포넌트 구현 ## 🎈 기대 효과 ## 📎 추가 정보 |
## 📑 버그 설명 ## 🔄 재현 방법 문제를 재현할 수 있는 과정을 단계별로 적어주세요. 1. ... 2. ... 3. ... ## 🎈 기대 결과 ## 📎 추가 정보 |
## 📑 질문 내용 ## ✏️ 시도한 것 ## 📎 추가 정보 |
추가로.. 이슈 템플릿 만들어서 팀원들한테 이슈 등록하는 법을 알려줬는데 팀원들이 양식에 무슨 내용을 써야 할지 잘 모르겠다고 해서 지피티 이용해서 팀원들에게 예시를 만들어 줬었는데 그것도 같이 올린다. (지피티 이용해서 만든 거니 참고만 하시길!)
[프론트엔드 예시]
## 📑 기능 설명
회원가입 페이지 UI 개발
사용자가 이메일, 비밀번호, 닉네임을 입력할 수 있는 회원가입 폼 컴포넌트를 구현합니다.
## ✅ 작업할 내용
- [ ] `/signup` 페이지 라우팅 추가
- [ ] 이메일, 비밀번호, 닉네임 입력 필드 UI 구현
- [ ] 입력값 실시간 유효성 검사 로직 추가
- [ ] 제출 버튼 및 비활성화 조건 처리
- [ ] 백엔드 API 연동 (`POST /api/v1/auth/signup`)
- [ ] 에러 메시지 및 성공 처리 UX 적용
- [ ] 반응형 대응 및 디자인 QA
## 🎯 기대 결과
- 회원가입 페이지가 정상적으로 라우팅되고 렌더링됨
- 잘못된 입력에 대해 실시간으로 에러 메시지를 표시함
- 유효한 값 입력 시 버튼이 활성화되고 서버 요청이 정상 수행됨
- API 응답 결과에 따라 사용자에게 성공/실패 메시지를 안내함
- Figma 디자인과 1:1 매칭되며 기본 반응형 레이아웃을 충족함
## 📎 추가 정보
- 사용 예정 라이브러리: `react-hook-form`, `axios`
- 비밀번호 유효성 기준: 영문/숫자/특수문자 포함 8자 이상
[백엔드 예시]
## 📑 기능 설명
회원가입 API 구현
사용자가 이메일, 비밀번호, 닉네임을 입력하여 회원가입할 수 있도록 하는 API를 구현합니다.
## ✅ 작업할 내용
- [ ] `POST /api/v1/auth/signup` 엔드포인트 생성
- [ ] 요청 바디 유효성 검증 (`email`, `password`, `nickname`)
- [ ] 이메일 중복 체크
- [ ] 비밀번호 암호화 처리
- [ ] 사용자 DB 저장 로직 추가
- [ ] 성공/에러 응답 포맷 정의 및 적용
- [ ] 유닛 테스트 및 통합 테스트 작성
## 🎈 기대 효과
- 중복 이메일에 대해 `409 Conflict`가 반환됨
## 📎 추가 정보
- 이메일 정규식: `^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$`
- 비밀번호 최소 8자 이상, 영문/숫자/특수문자 포함
이렇게 세 개의 이슈 템플릿을 작성해보았는데 이제 커밋해보겠다..!!
커밋하고나니 .github/ISSUE_TEMPLATE 폴더가 생겼다.
해당 폴더 안에는 이렇게 md 파일이 만들어져있었다.
이렇게 웹으로 만들지 않아도 그냥 바로 루트에 .github/ISSUE_TEMPLATE 폴더를 만들어서 그 안에 이슈 템플릿 파일을 넣어도 된다.
이슈 만드려고 들어갔더니 잘 뜬다!
앞으로는 이슈 만들 때 바로 양식이 채워져 있다 ^-^
'DevOps > Git' 카테고리의 다른 글
| [Git] Repository 미러링 (저장소 커밋 포함 복사) (0) | 2025.01.19 |
|---|---|
| [LeetHub] 릿코드 풀이 깃허브에 자동 업로드하기 (0) | 2022.02.11 |
| [GitHub] 깃허브 사용법 - 리포지토리 생성, 로컬 저장소 연결, 코드 업로드 (0) | 2022.02.11 |