"본 문서는 생활코딩의 github issues 강의를 정리한 글입니다."
업무와 협업을 위한 게시판을 작성하는 곳
일종의 레포의 게시판
"새로운 이슈들을 만들고(Open Issue) 작업이 끝나면 이슈를 닫는다.(Closing Issus)"
이 개념이 가장 기본이 되는 개념으로 이를 통해 업무와 협업에 필요한 내용들을 정리하고 관리한다.
Github Issue에선 프로젝트에서 업무 및 협업에 필요한 글을 작성하는데 여기서 작성하는 글 하나하나를 이슈(Issue)라고 부른다.
아래의 내용들을 통해서 이슈를 어떻게 생성하고 관리하는지 알아보도록 하자.
1. 새로운 이슈를 작성하기
New Issue
버튼 누르기
제목과 내용을 작성
Submit new Issue
버튼 누르기
2. 해결된 이슈를 닫기
해결된 문제에 해당하는 이슈를 클릭
Closeissue
버튼을 통해서 issue를 close 가능
close된 이슈는 다시 reopen 할 수 있다.
3. 이슈 확인하기
이슈는 업무 및 협업에 필요한 하나의 글이라고 하였다.
업무는 다른 사람에게 할당하여 일을 분배할 수 있다.(Assignees)
또한 현재 지시한 업무가 어떤 상태인지(Labels_처리할 업무에 버그가 존재하는지, 처리하지 않고 유지해야 하는 업무인지, 다른 업무와 중복되지는 않는 업무인지 등등..)를 다른 사람과 공유하면 일에 대한 명시사항을 빠르게 확인할 수 있고 효율적인 업무 관리가 가능할 것이다.
Github Issues에선 해당 기능들을 제공하고 있다.
1. Assignees : 담당자가 누구인지 나타내는 상태
2. Labels : 현재 이슈의 상태를 표현할 수 있는 상태
필터 기능과 상태 기능이 만났을 때 발휘되는 큰 효용을 발휘한다.
Using Filters
- Your issues : 내가 만든, 작성한 이슈를 확인할 수 있는 필터
- Your pull requests : ...
- Everything assigned to you : 나에게 할당된 이슈를 확인할 수 있는 필터
- Everything mentioning you : 코멘트로 내가 멘션된 이슈를 확인할 수 있는 필터(아래 참조 기능 글 참고)
Using Filter Category Button
- 아래의 버튼들을 이용해서도 필요한 내용을 필터링할 수 있다.
1. 사용자 멘션하기
@
를 이용하여 특정 사용자를 멘션(참조)할 수 있다.2. 이슈 멘션하기
#
를 이용하여 특정 이슈를 멘션(참조)할 수 있다.3. 커밋 멘션하기
각 이슈에 코멘트를 달 때 커밋 Hash 번호를 이용해서 커밋을 멘션할 수 있다.
해당 번호를 복사해서 붙여넣으면 아래와 같이 멘션되는 것을 확인할 수 있다.
템플릿 기능을 이용하여 이슈의 형식을 지정할 수 있다. 사람들이 이슈를 생성할 때 어떠한 형식을 유도하고 싶을 때 사용하는 기능이다.
템플릿이 적용된 Github Issues
템플릿 만들기
issue_template.md
파일을 생성해준다.issue_template.md
파일에는 issue 파일을 생성할 때 표시될 template 내용을 작성해준다.issue_template.md
파일을 repository의 root 디렉토리에 저장해준다.