[GitHub] 깃 이슈 알아보기

프로젝트를 진행하면 레포지토리에서 깃 이슈 탭을 확인해보신 적이 있을 겁니다.
처음에는 단순히 버그 리포트만 한다고 생각하며 넘겼는데 프로젝트에서 직접 사용해보면서 그게 아니라고 느꼈습니다.

오늘은 깃 이슈에 대해서 알아보겠습니다.

---

Git Issue

깃 이슈는 다음과 같은 항목을 작성할 수 있습니다.

• 해야 할 일 기록
• 버그 리포트
• 새로운 기능 제안
• 팀원들과의 토론

외에도 프로젝트와 관련된 거의 모든 것을 기록하고 소통하는 공간입니다.

 

Issue Template

깃 이슈에 사용할 템플릿을 깃허브에서 등록할 수 있습니다.

General 탭의 이슈 템플릿 설정 항목

설정에 들어가 General 탭을 확인해보면 템플릿을 설정할 수 있는 항목이 있습니다.

# .github/ISSUE_TEMPLATE/feature.md
---
name: 기능 개발
about: 새로운 기능 개발
---

## 목적

## 작업 내용

## TODO

## 참고사항

이런식으로 템플릿을 작성해두고 이슈를 등록할 때마다 사용하면 편하게 사용할 수 있습니다.

 

Git Issue를 사용하면서 실수한 점

깃 이슈를 다시 사용하면 이런 건 지켜야지라고 생각한 것을 적어보겠습니다.

첫번째, 큰 이슈를 만들지 않기입니다.
예를 들어 회원 기능 개발보다는 로그인 폼 개발, 로그인 API 연동 등으로 이슈를 생성하는 것입니다.
이슈를 크게 만들면 작업의 추적이 어려워지고 꼼꼼한 코드 리뷰가 어려워집니다.

두번째는 커밋할 때 이슈 번호를 달기입니다.
이슈 번호를 커밋 메시지에 추가하면 해당 이슈에서 커밋 상황을 한눈에 파악할 수 있습니다.
커밋 템플릿을 활용해 여러줄을 커밋할 시 #을 주석으로 인식하므로 주의해야 합니다.

마지막으로 진행상황을 업데이트하자입니다.
작업하는 인원이 정해지면 담당자로 지정해주고 작업이 완료되면 이슈를 닫아줍니다.
중간상황을 코멘트로 남기는 것도 중요한 것 같습니다.

---

처음에는 이슈를 작성하는 것이 불편하고 번거롭다고 느꼈는데,
프로젝트를 마치니까 이슈가 없는 게 불안해지네요.

글을 끝까지 읽어주셔서 감사합니다.
틀린 내용이 있다면 댓글로 지적 부탁드립니다.