Git - [ issue 관리 ]

깃허브에서 이슈(Issue)는 프로젝트를 진행하면서 발생하는 다양한 이벤트들을 의미한다. 발견된 버그나 추가할 기능, 개발해야할 새로운 이슈나 설계사항들을 이슈로 만들 수 있다.

 

1. issue 생성

깃허브 레포지토리의 이슈 탭에서 새로운 이슈를 생성할 수 있다. 해당 저장소에 이슈를 생성할 수 있는 권한을 가지고 있어야한다.

레포지토리의 issues 탭에서 초록색 New issue 버튼 클릭

New Issue 버튼을 클릭하면 아래 사진처럼 새로운 이슈를 생성할 수 있는 페이지가  뜬다.

 

이슈 작성 화면의 오른쪽을 보면 이슈와 관련된 다양한 기능들을 확인할 수 있다.

• Assignees : 해당 작업의 담당자. 두 사람 이상 여러명을 지정 가능
• Labels: 해당 작업의 성격
• Milestone: 해당 작업이 속한 파트

 

---

2. issue 닫기 / 삭제 / 핀하기

해결된 이슈는 'Close issue' 버튼을 눌러서 닫아줘야한다. 

Closed 상태의 이슈들은 삭제되는 것은 아니고 나중에도 볼 수 있다.

 

이슈를 삭제할 때는 우측 하단의 'Delete issue' 버튼을 클릭하면 된다. 이슈를 삭제하면, 이슈에 대한 내용이 완전히 지워지며 나중에 다시 볼 수도 없다. 히스토리를 남기기 위해서는 Delete보다는 Close 하는 것이 좋다.

 

중요한 이슈는 Pin해서 위로 올릴 수 있다. 이슈 페이지 오른쪽 하단에 있는 Pin Issue 메뉴를 선택하면 된다.

 

 

---

3. issue 라벨 생성

각 이슈가 어떤 종류인지 구별하기 위해 라벨(Label) 기능을 사용할 수 있다.

 

issue 탭에서 우측의 초록색 New issue 왼쪽에 Labels를 클릭해서 라벨을 편집할 수 있다.

여기에서 'New Label' 버튼을 눌러서 새로운 라벨을 추가할 수도 있고, 각 라벨 오른쪽 끝에 Edit/Delete 를 클릭해서 기존 라벨을 지우거나 편집할 수도 있다.

 

bug	예기치 않은 문제 또는 의도하지 않은 동작(버그)
documentation	문서를 개선하거나 추가 할 필요가 있음을 나타냄
duplicate	해당이슈 또는 PR이 기존에 있음을 나타냄
enhancement	새로운 기능 요청을 나타냄
good first issue	처음 기여해볼 사람에게 좋은 문제를 나타냄
help wanted	관리자가 문제 또는 PR 요청에 대한 도움을 원함을 나타냄
invalid	이슈 또는 PR 요청이 더 이상 관련이 없음을 나타냄
question	이슈 또는 풀 요청에 추가 정보가 필요함을 나타냄
wontfix	문제나 PR 요청에서 작업이 계속되지 않음을 나타냄

 

---

4. 마일스톤

마일스톤은 Sprint를 관리해주는 도구로, 유사한 이슈들을 하나로 모아 일정관리를 할 수 있다. Due Date를 설정한 후 해당 기간 동안 수행할 Issue들을 등록해 놓으면 Open된 Issue와 Close된 Issue를 카운트하여 Percentage로 보여준다.

 

New issue 버튼의 좌측에 보면 Milestibes 버튼이 있다

여기서 New milestones이나 Create a Milestone 버튼을 클릭해서 마일스톤을 생성할 수 있다.

 

마일스톤 생성

 

---

5. issue 템플릿 설정

프로젝트의 settings 에서 아래쪽의 Feature를 보면 Set up templates 버튼이 있다.

 

여기서 select를 클릭하면 추가할 이슈 템플릿의 타입이 나온다.

- 버그 리포트를 위한 템플릿

- 기능 개발용 이슈 템플릿

- 사용자들가 만들 수 있는 템플릿

이 있다.

 

나는 Feature request를 클릭했다. 그러면 화면에 추가되고 오른쪽에 Preview and edit 버튼이 뜬다.

 

여기서 오른쪽의 연필 모양 아이콘을 클릭하면 수정할 수 있다.

 

내용 수정 후 상단 우측의 Propose changes 버튼을 클릭한 후

 

커밋 메세지를 남기고 Commit changes 버튼을 클릭하면 된다.

 

 

그러면 이슈를 생성할 때 어떤 템플릿을 사용할 지 선택할 수 있는 메뉴가 나온다. 

원하는 템플릿에서 Get started를 클릭하면  작성한 템플릿대로 이슈가 자동 생성된다.

 

 

---

참조

https://hbase.tistory.com/211

[Git] Github 이슈, 라벨, 마일스톤 기능 및 사용법

https://velog.io/@yulhee741/Github-Issue-Templates%EC%9C%BC%EB%A1%9C-Issue-%EC%89%BD%EA%B3%A0-%EC%B2%B4%EA%B3%84%EC%A0%81%EC%9D%B4%EA%B2%8C-%EC%9E%91%EC%84%B1%ED%95%B4%EB%B3%B4%EA%B8%B0https://cheese10yun.github.io/github-proejct/

Github Issue Templates으로 Issue 쉽고 체계적이게 작성해보기

https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels

https://terry-some.tistory.com/93

GitHub를 활용한 이슈 관리