Issue 사용 가이드

다람·2025년 8월 19일
0

팀 프로젝트를 진행하면서 협업하면서 서로 어떤 작업을 진행하고, 진행하려하는지 파악하기위한 목적으로 Issue를 사용하기로 하였습니다.
Issue에 대하여 팀원들에게 설명을 진행하였던 부분을 글로 정리해보았습니다.

1. Issue란?

  • 작업할 내용, 버그, 개선 사항, 질문 등을 관리하기 위한 용도
    • 누가 어떤 작업을 하고 있는지 추적할 수 있음
    • 진행 상황(진행 중/완료)을 쉽게 공유할 수 있음
    • PR과 연결되어 자동으로 닫을 수 있고 상태가 업데이트 됨으로써 진행 상황을 서로 파악하기 좋음

2. Issue를 사용하는 이유

  1. 작업 내용 기록
    • 구두로 말하는 것보다 코드 변경 이유, 목표 등을 문서로 남길 수 있음
  2. PR과 연결 가능
    • 커밋 메시지나 PR의 본문에 closed #이슈번호를 적dmaus, PR이 merge가 될 때 Issue가 자동으로 닫히게 됨.
  3. 기능 단위로 관리
    • 기능(작업) 단위로 브랜치를 만들 때, Issue 번호를 브랜치명에 포함시켜서 관리가 가능하며 추적이 가능

3. Issue 작성 규칙

  1. 하나의 Issue에는 하나의 작업/기능/버그만 기록할 것
  2. 명확한 제목으로 어떤 작업인지 바로 이해할 수 있도록 작성할 것
    • 예: 회원가입 API 구현
  3. 진행 상황 체크리스트를 포함할 것

4. Issue 템플릿

Github에서 Issue를 생성할 때 팀장이 작성해둔 템플릿을 기반으로 사용

5. Issue 사용 예시

  1. 새 기능을 작업하는 경우
    • 제목: 회원가입 API 구현
    • 내용
      ## 설명
      Spring Boot 기반으로 회원가입 API 개발
      이메일 중복 체크 적용
      
      ## 진행 상황
      - [ ] Controller 생성
      - [ ] Service 로직 구현
      - [ ] 테스트 코드 작성
      
      ## 부가 설명
      비밀번호 암호화 적용은 다음 이슈(#12)에서 처리 예정

profile
개발하는 다람쥐

0개의 댓글