이슈 작성 가이드라인

목차 세부정보

• 이슈를 적는 목적
• 템플릿
• 결론
• 시작하기
• 작성하기(공통)
  • 제목(Title)
  • 작성자(Assignees)
  • 라벨(Labels)
  • 프로젝트(Projects)
  • 마일스톤(Milestone)
• 버그 리포트
  • 문제 식별
  • 문제 재현 방법
  • 예상되는 결과
  • 문제의 심각도, 우선순위
• 새로운 기능 추가
  • 구현하려는 기능
  • 기능의 상세 작업내용
  • 예상 소요 시간
• 이슈 코멘트 추가하기
  • 질문
  • 해결 방법 제시
  • 문제 가져가기

(번외) 이슈는 왜 적을까?

Leo
언제나 가장 좋은 방법은 직접 해보는 것입니다.
이슈가 아직 두렵고, 어려운 팀원에게 도움이 되었으면 좋겠습니다.
이슈를 어떻게 적어야 하는지 형식을 다루지 않습니다. 그것은 정해져있지 않습니다.

이슈를 적는 목적

Q
이슈를 적는 이유가 무엇인가요?

Leo
이번 모행 프로젝트에서는 개발 중 가장 많이 시간을 뺏어가는 두 가지 유형의 문제를 예방하는 것에 초점을 맞췄습니다.

1. 팀원이 어떤 작업을 하는지 알면 반복작업/충돌을 예방할 수 있습니다.
2. 어떤 문제에 부딪혀 고생하고 있는지 알려서 빠르게 해결합니다.

Q
같은 내용을 팀 미팅이나 데일리 스크럼을 통해서도 공유 가능한데 왜 이슈를 사용하나요?

Leo
모행 팀의 모든 소스코드를 github을 통해 관리하기 때문입니다.
이슈번호와 깃을 사용한 코드 추적이 쉽습니다.
코드와 묶여 한곳에서 관리되기 때문에 여러 의견이 섞여있는 회의록보다 간결합니다.

템플릿

Q
이슈템플릿의 항목을 어떤 기준으로 작성했나요?

Leo
처음 작성하려다보니 막막해서 Facebook의 React 프로젝트의 이슈 형식을 가지고 왔습니다.
하지만 이유없이 업계 선두주자의 표준을 따라하는 것을 좋아하지 않습니다.
팀원의 타당한 의견이 테크기업의 이름값에 묻힐 수 있기 때문입니다.

예를 들어 '버그 재현 단계'와 같은 항목은 우리 프로젝트에 적합해보이지 않습니다.
React는 불특정다수가 이슈를 해결하기 때문에 환경과 과정을 공유해야만 버그를 재현해서 고칠 수 있습니다.
6인으로 구성원이 이루어진 우리팀의 경우 전화를 걸어 물어보는 것이 훨씬 더 정확하고 빠를 수 있습니다.
과연 해당항목이 필요할까요?

끝까지 이유를 물어봐주세요. 정확한 이유를 설명할 수 없다면 그 항목은 필요없는 것입니다.
반대로 필요한 항목이 있다면 언제라도 추가해야합니다.

결론

어떻게 적는지보다 왜 적는지가 더 중요합니다.

1. 충돌방지, 반복작업 방지
2. 빠른 에러해결

이슈로 예방할 수 있는 다른 문제가 보인다면 빠르게 의견을 주세요.
모행 팀의 성공적인 이슈를 기원합니다.

시작하기

현재 상황에 맞게 어떤 이슈를 작성할지 선택합니다.

작성하기(공통)

제목(Title)

간결하고 이해하기 쉽게 작성해주세요.

작성자(Assignees)

이슈를 생성한 사람을 클릭해서 넣어주세요.

라벨(Labels)

feat, bug, team, D-day 등등 해당되는 라벨 여러개를 골라서 넣어주세요.

프로젝트(Projects)

현재 진행하고 있는 프로젝트를 입력해주세요.

마일스톤(Milestone)

프로젝트의 큰 흐름중 어느 단계에 해당하는지 골라주세요.

버그 리포트

총 4단계로 이루어져 있습니다.

어떤문제인지 식별하고, 우선순위를 파악한뒤 본인이 해결 할 지 결정해야합니다.

graph LR

A[문제 식별] --> B[문제의 심각도, 우선순위] -- 해결 or 보류 --> C[문제 재현 방법] --> D[예상되는 결과]

Loading

문제 식별

• 발생한 버그나 문제라고 생각한 이유를 찾아서 작성해주세요.

문제 재현 방법

• 다른사람이 같이 해결하거나 원인을 파악할 수 있도록 버그가 일어났던 상황을 이야기하는 단계입니다.
• 포함해야하는 정보
  • 사용하는 기기(os, 브라우저 종류)
  • 오류 메세지, 혹은 화면 스크린샷
  • 그 외 따라할 수 있는 모든 정보

예상되는 결과

• 버그를 해결했을 때 어떻게 동작해야 하는지에 대한 설명

문제의 심각도, 우선순위

• 해당 문제가 얼마나 심각한지, 얼마나 빨리 해결해야 하는지에 대한 정보를 작성해주세요.
• 문제가 복잡해서 판단을 보류하고 싶다면 일단 급함으로 선택한뒤, 이슈를 수정하거나 다른사람을 @로 태그해주세요.

새로운 기능 추가

구현하려는 기능

• 어떤 작업을 진행할지 팀원에게 알려주는 단계입니다.
• 추후에 commit, PR과 연동하여 작업을 추적할 수 있습니다.

기능의 상세 작업내용

• 구체적으로 어떤 작업을 진행할지 작성해주세요.
• 포함하면 좋은 내용
  • 구현할 기능하기 위해 필요한 단계
  • 정확한 구현방법
  • 수정인 경우, 건드릴 파일의 제목

예상 소요 시간

• 구현을 위해 대략적인 시간을 작성해주세요.

이슈 코멘트 추가하기

질문

• 다른 사람의 버그, 기능에 모르는 단어나 내용이 이해가지 않는 경우 질문을 남겨주세요.
• 해당 개념을 이해하기 위한 자료나 링크를 제공해주셔도 좋습니다.

해결 방법 제시

• 경험, 혹은 브라우저 서칭을 바탕으로 예상되는 해결 방법을 제시해주세요.

문제 가져가기

• 해당 이슈, 혹은 기능이 본인이 작업했을때 더 나은 방향이라고 판단되면 이슈를 가져가서 작업을 진행해주세요.
• 이슈를 가져갈때는 Assignees를 수정해주세요.