////
Search
Duplicate

issue 작성 가이드

1. issue 발급 단위

Issue는 기능 단위 혹은 작업단위로 발급한다
기능 단위로 진행사항을 파악하기 위함
예시
1. seolim이 backend에서 맡은 임무가 /api/team과 /api/id api의 api문서 작성인 경우 발급된 issue는 2개 - /api/team api문서 작성 - /api/id api 문서 작성 2. seolim이 frontend에서 맡은 임무가 frontend에서 login button제작과 teamlist 흐름도 작성인 경우 발급된 issue는 2개 - login button 제작 - team list 흐름도 작성
Plain Text
복사

2. issue 작성 규칙

2 - 1. issue 구성

issue는 제목, 본문 으로 구성된다.
본문은 Description, TODO로 구성된다.

2 - 2. 제목

issue 제목은 어떤 작업을 하는지로 구성한다
예시
1. backend에서 맡은 임무가 login 시퀀스 다이어그램 작성인 경우 "login router 시퀀스 다이어 그램 작성" 이 제목 2. frontend에서 맡은 임무가 team list 컴포넌트 흐름도 작성인 경우 "team list component 컴포넌트 구현" 이 제목
Plain Text
복사

2 - 3. 본문

Description: 작업에 대한 간단한 설명 추가
예시
1. backend에서 맡은 임무가 login 시퀀스 다이어그램 작성인 경우 "client에서 POST /api/login 요청이 왔을 때 시퀀스 다이어 그램 작성" 이 설명 2. frontend에서 맡은 임무가 teamList 구현인 경우 "main Page의 teamList의 형태 구현" 이 설명
Plain Text
복사
TODO: 작업을 위해 해야할 내용을 세분화하여 기록
체크박스 형태로 만든다
체크 및 완료는 "진행 가이드(link)"를 참고
todo는 작업을 하면서 요건에 따라 수정(추가 / 삭제)할 수 있다
todo는 다른 멤버가 작업을 할때 어떤 행동을 했는지 파악할 가장 좋은 방법이므로 귀찮아도 적도록 하자.
예시
1. backend에서 맡은 임무가 login 시퀀스 다이어그램 작성인 경우 TODO - [] 시퀀스 다이어 그램 작성 2. frontend에서 맡은 임무가 teamList 구현인 경우 TODO - [] team List header 구현 - [] team List item 구현 - [] team List item 내의 hash 추가 방법 선정 - [] team List item 내의 hash 구현 ※ todo는 작업 도중에 새로운 방식이나 방법을 알게 될 경우 변경/수정할 수 있다
Plain Text
복사

3. 통합 예시

3 - 1. backend

제목은 "login router 시퀀스 다이어 그램 작성"
Description client에서 POST /api/login 요청이 왔을 때 시퀀스 다이어 그램 작성 TODO - [] 시퀀스 다이어 그램 작성
Plain Text
복사

3 - 2. frontend

제목은 "team list component 구현"
Description main Page의 teamList의 형태 구현 TODO - [] team List header 구현 - [] team List item 구현 - [] team List item 내의 hash 추가 방법 선정 - [] team List item 내의 hash 구현
Plain Text
복사

4. issue 설정

이슈 발급에서 label(라벨), project, milestone(주기), assign(담당자)를 설정한다.
담당자는 본인으로 설정한다
project는 각자의 project(front Project / backend Project)로 설정한다
milstone은 해당 작업의 주기로 해당 주기의 milstone으로 설정한다.