GitHub 협업 가이드 - Issue

Issue

issue는 전체적인 작업 내용을 세분화하여 쪼갠 개발 작업의 단위이다.

issue를 작성함으로써 작업의 history를 관리할 수 있다.

commit convention과 마찬가지로 issue의 제목 앞에 prefix를 붙여 어떤 사항에 대한 issue인지 한눈에 파악할 수 있게 한다.

    ex) [FEAT], [REFACTOR], [FIX]

각 issue에 대응하는 feature 브랜치를 생성하여 작업을 진행한다. 이 때, 브랜치의 이름을 아래와 같이 issue tag를 붙여 작성하면 브랜치에서 작업하는 내용을 파악하기 쉽다.

    ex) feat-12/branch_name (12번 이슈를 해결하는 기능 구현 브랜치라는 의미)

 

Issue Template

issue에는 이 작업이 왜 필요한지(Background), 어떤 작업을 해야하는지(To Do), 관련된 이슈나 작업은 무엇이 있는지(Issue Tag)를 기록한다.

issue를 작성할 때, 반복되는 내용들은 미리 template으로 만들어두면 더 편하게 issue를 작성할 수 있다.

issue template을 생성하기 위해서는 먼저, GitHub 저장소의 Settings 탭에 있는 General에 들어간다.

 

스크롤을 내리다보면 Features 항목에서 Issues 밑에 있는 Set up templates 버튼을 클릭한다.

 

여기서 issue template을 생성할 수 있다. Feature request와 Bug report의 기본 template이 존재하며, 이를 수정해서 사용할 수도 있다.

기본 template으로는 Feature request와 Bug report가 존재한다.

preview and edit 버튼을 눌러 기본 template을 수정할 수 있다.

빨간색 박스로 표시된 연필 모양 버튼을 누르면 내용을 편집할 수 있다.

위와 같이 template 내용을 수정했다.

 

template 작성이 완료되었으면 Propose changes 버튼을 클릭하여 commit message를 적고, 변경 사항을 commit한다.

commit message는 commit convention에 맞게 작성한다.

 

이제 issue template이 등록되었으므로, 새로운 issue를 등록할 때 issue template을 활용할 수 있다.

issue template을 사용하길 원하지 않는다면, Open a blank issue를 눌러 빈 내용의 issue를 생성할 수 있다.

여기에 내용을 추가해 issue를 완성할 수 있다.

 

issue template을 기반으로 프로젝트 초기 세팅 issue를 생성한다.