[🐙 Git & Github] 깃헙 이슈 이해하기 + Issue & PR Template 만들기

Github Issue

프로젝트의 기획, 작업, 버그 및 개선 사항 등 모든 것을 이슈라고 한다.

이 모든 활동에 대해 이슈를 작성함으로써 누가 해야하는 지, 어떤 작업을 해야하는 지, 얼마나 진행되었는 지 등에 대한 정보를 효율적으로 확인하고 추적 할 수 있다.

이슈는 커밋 메세지나 pull request에도 연결 할 수 있으며 팀원들이 코멘트도 남길 수 있어 피드백 하기에도 좋다.

 

 

Issue - New Issue를 누르면 위와 같은 창이 뜨는데 오른쪽에 위치한 4가지 항목을 차례대로 살펴보자면

• Assignees : 담당자 (이슈 상태가 변경 될 때 마다 담당자에게 이메일이 보내짐)
• Labels : 해당 작업의 유형 (커스터마이징 가능)
• Projects : 연결할 프로젝트
• Milestone : 프로젝트가 도달해야 할 목표 지점 (게이지 바를 통해 진척도 파악 가능)

 

이슈 활용 예시

• 버그 보고: "로그인 버튼 클릭 시 오류 발생"이라는 제목으로 이슈를 생성하고, 오류 메시지, 재현 단계 등을 상세히 기록합니다.
• 새로운 기능 요청: "사용자 프로필에 좋아요 기능 추가"라는 제목으로 이슈를 생성하고, 기능의 상세한 설명과 예상되는 화면 디자인을 첨부합니다.
• 개선 사항 제안: "검색 기능 성능 개선"이라는 제목으로 이슈를 생성하고, 현재 검색 기능의 문제점과 개선 방안을 제시합니다.

 

Issue Template

이슈 템플릿을 지정해두면 새 이슈를 생성할 때 마다 자동으로 템플릿이 생성되어 일관성 있는 이슈를 생성하기에 좋다.

 

→ Setting - Features - Issues - set up templates

위와 같은 루트로 이슈 템플릿을 생성 할 수 있으며 마크다운 형식을 지원한다.

생성 후 커밋하게 되면 최상위 위치에 .github 폴더가 생성되고 안에 .md 파일이 생긴걸 확인 할 수 있으며 이슈 생성 버튼을 누르면 템플릿을 고를 수 있게 된다. 이슈 템플릿은 여러개 만들 수 있다!

 

+ )

 

PR Template

PR도 템플릿을 만들 수 있다! 이슈와는 다르게 PR 템플릿은 1개만 만들 수 있다.

 

.github 폴더 안에 PULL_REQUEST_TEMPLATE.md 파일을 만들고 똑같이 마크다운 형식을 사용해 템플릿을 작성해주면 된다.

 

 

 

🔗 참고 포스팅 출처

https://docs.github.com/ko/issues

GitHub Issues 설명서 - GitHub Docs

https://amaran-th.github.io/Github/[Github]%20Issue%20&%20PR%20Template%20%EC%84%A4%EC%A0%95%ED%95%98%EA%B8%B0/

[Github] Issue & PR Template 설정하기