[GitHub] Issue

Issue

프로젝트에서 해야할 일, 문제, 아이디어를 기록하고 관리하는 게시판

개인 프로젝트든 팀 프로젝트든 거의 필수로 쓰임

• 버그 리포트
• 새 기능
• 리팩토링 / 개선 작업
• 할일(To-do) 관리
• 질문 / 논의

기본 구성 요소

제목

짧고 명확하게 무엇을 해야 하는 지 한 줄 요약

[BUG] JWT 만료 토큰일 때 500 에러 발생

본문

문제 상황, 배경, 요구사항 등을 자세히 작성

제한은 없으므로 본인에게 맞는 템플릿을 찾아 사용하면 됨

• 현상
• 재현 방법
• 기대 결과
• 관련 코드 / 스크린샷

라벨

이슈의 성격을 한 눈에 보여줄 수 있음

• bug
• feature
• enhancement
• refactor
• docs
• question

팀 프로젝트의 경우 라벨 규칙을 정해두면 편함

Assignee (담당자)

이 이슈를 누가 처리할지 표시

개인 프로젝트면 자기 자신 assign

Milestone (마일스톤)

이슈가 속한 파트를 나타냄

태스크 카드를 시각화 할 수 있음

Milestone에 연결된 태스크 카드(Issue)가 종료되면 Milestone마다 진행 상황이 업데이트되는 것을 볼 수 있다. 이를 통해 연관된 이슈의 추적과 진행 상황을 한눈에 파악할 수 있다.

---

이슈 생성

참고란 첫 번째 링크에 자세히 설명되어 있음

GitHub 레포지토리의 Issues 탭에 들어가 New Issue 버튼을 클릭하면 이슈를 생성할 수 있음

이때 기존에 작성해둔 템플릿을 활용하여 이슈를 생성할 수 있다

label을 설정하여 해당 이슈의 성격을 한 눈에 보기 쉽게 표시 가능

템플릿 작성

1. GitHub 레포지토리의 Settings 탭에 들어간 후, 스크롤을 아래로 내리면 Features란 내에 Issues가 있음
2. 해당 부분에서 Set up templates 버튼 클릭
   
3. 작성해둔 템플릿이 없으면 해당 페이지에서 템플릿 생성 - Custom template 클릭
4. 템플릿 작성 완료 후, 해당 레포지토리에 템플릿 등록 위해 commit 진행

마일스톤

Issues 탭 내에서 Milestones 버튼 클릭

New milestone 버튼 클릭 시 새 마일스톤을 작성할 수 있음

마일스톤의 제목, 기한, 내용 작성 후 생성 버튼 클릭

생성된 마일스톤에 성격이 비슷한 이슈들을 할당하면 각 이슈들의 진행사항 등을 한 눈에 확인 할 수 있음

PR 연결

Issue와 Pull Request를 연결하여 관리

PR이 merge되면 Issue가 자동으로 닫힘

1. Issue 생성
   [FEATURE\] Redis 기반 이메일 인증 구현
2. 브랜치 생성
   feature/email-verification
3. 작업 후 PR 생성
4. PR 본문에 Closes #23
5. Merge
   --> Issue 자동 종료

---

참고

https://hyeonic.tistory.com/181

[git, github] git issue 생성 및 작성 방법 (1)

https://hyeonic.tistory.com/181)

https://velog.io/@pikadev1771/Github-%EC%9D%B4%EC%8A%88-%EB%A7%88%EC%9D%BC%EC%8A%A4%ED%86%A4

🌿 Github 프로젝트 관리 기능 : Issue & Milestone / Projects

https://codesyun.tistory.com/entry/Git-Issue-%EB%B0%8F-Issue-Branch-%EC%83%9D%EC%84%B1%ED%95%98%EC%97%AC-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EA%B4%80%EB%A6%AC%ED%95%98%EA%B8%B0#google_vignette

[Github] Issue 및 Issue Branch 생성하여 프로젝트 관리하기