[Github] 효율적인 협업을 위한 이슈 사용

1. Issue란?

'프로젝트에서 진행하는 일'을 말한다. 배포, 기능 구현, 버그 해결, 문서 수정 등 모든 것이 '이슈'에 해당한다.

개발자들은 이슈 트래킹을 통해 프로젝트의 이력과 진행 상황, 그리고 버그에 대한 해결 방법 등을 확인할 수 있다. 

 

---

2. 이슈 생성하기

 

(1) Issue 탭 - New issue 클릭

 

 

(2) 이슈 작성하기

 

저 버튼을 클릭하면 이렇게 이슈 작성 페이지가 나타난다. 제목을 적고, 내용을 적고, 오른쪽 아래 Submit new issue 버튼을 누르면 끝!

 

 

이슈는 프로젝트를 파악하기 위해 보는 것이기 때문에, 잘 모르는 사람이 봐도 한눈에 알아볼 수 있어야 한다. 그래서 때로는 템플릿을 지정하여 효율적이고 일관된 이슈를 작성하기도 한다.

 

---

3. 이슈 템플릿 지정하기

 

(1) Setting 탭 - Features - Set up templates 클릭하기

 

 

(2) 원하는 양식 선택하기

 

- Bug report: 버그 해결과 관련된 이슈를 발행할 때 사용

- Feature: 기능 개발과 관련된 이슈를 발행할 때 사용

- Custom templae: 그 외 커스텀 템플릿 작성 가능

 

여기서는 Feature request를 선택해보겠다. 

 

(3) Preview and edit 버튼 클릭

 

 

(4) 연필 아이콘을 클릭하여 수정 가능

 

 

(5) 템플릿 작성

 

- Template name: 템플릿 이름을 적어주면 된다.

- About: 템플릿에 대한 설명을 적는다.

- Template content: 템플릿을 마크다운 문법에 맞게 작성해주면 된다. 

- Issue default title: 해당 템플릿을 사용했을 때의 기본 제목을 설정할 수 있다.

- Assignees: 해당 템플릿으로 작성한 이슈의 담당자를 설정할 수 있다. 기능 구현은 모두가 담당하므로 따로 지정하지 않았다.

- Labels: 이슈에 카테고리를 부여할 수 있다. 해당 템플릿으로 작성한 이슈는 Feature 라벨을 부여받는다.

 

그리고 마지막으로 우측 상단 Propose changes 버튼을 클릭해주면 템플릿 작성 끝!

 

---

4. 이슈 닫기

 

그리고 이슈를 생성하면, 이렇게 팀원이 어떤 일을 하고 있는지 파악할 수 있다.

 

 

 

 

일이 해결되면 이슈를 닫아야 하는데, 스크롤을 아래로 내리면 나타나는 Close Issue 버튼을 누르면 이슈가 닫히고, 해당 작업이 완료된 것으로 파악한다. 닫은 이슈는 다시 열 수 있다.

 

코멘트에는 이슈와 관련 질문 등을 자유롭게 적을 수 있다.

 

 

 

지금까지 이슈를 열고 닫는 방법과 이슈 템플릿을 작성하는 법에 대해 알아보았다.

이제 팀원이 무슨 일을 하고 있는지 궁금할 땐 이슈 탭을 확인해보도록 하자🙌