Issue 컨벤션 정의

Register Issue

• 새로운 문제를 발견했거나 질문이 있는 경우 Issue를 생성한다.

• Issue를 이해하는 데 도움이 되도록 템플릿을 작성

Issue Classification (이슈 분류)

Examination

• triage - 아직 확인되지 않는다.

• accepted - 문제가 확인되었으며 귀하의 보고서에 동의한다.

• invalid - 문제 형식에 맞지 않다.

• wonfix - 정책에 의해 결정, 다른 접근 방식으로 해결할 수 있거나 더 많은 리소스가 필요할 수 있다.

• duplicate - 유사한 문제 보고서가 있다.

Type

• bug - 수정 필요

• document - 코드가 아닌 업데이트 문서 필요 (e.g. comment, README)

• feature - 새로운 기능 요청

• enhancement - 존재하는 기능 업데이트 요청

• question - 질문

Status

• to do

• in progress - 작업 중

• in review - 문제가 해결되었으며 검토를 위해 PR을 제출할 준비가 되었다.

Communicate with label

Wait Examination

• 새로운 Issue가 등록되면, default label은 triage 이다.

• review를 할때까지 하나의 label (triage)만 가진다.

Sort Issue

• acceptable label으로 변경

• 잘 선택된 TYPE label이 지정된다.

• 해결이 시작되면 STATUS label이 추가된다.

• Not acceptable label은 비활성 레이블(invalid, wontfix, duplicate) 중 하나로 변경

Close issue

• 문제가 해결되었거나 비활성화된 경우 닫는다.

Issue Title

• 제목은 ISSUE 성격에 맞게 자유롭게 합니다.
• 고정된 Text값들을 공통으로 사용할 수 있도록 리팩토링
• 사이드바 호버 후 빠른 속도로 재 호버시 텍스트가 사라지는 문제 발생

Issue Template

• Github에서 제공하는 기본 템플릿

Feature Request

• Is your feature request related to a problem? Please describe. (문제설명) A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

• Describe the solution you'd like (솔루션 설명) A clear and concise description of what you want to happen.

• Describe alternatives you've considered (대안 기술) A clear and concise description of any alternative solutions or features you've considered.

Bug Request

• Describe the bug (버그 설명) A clear and concise description of what the bug is.

• To Reproduce (버그 발생 배경) Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

• Expected behavior (예상되는 동작) A clear and concise description of what you expected to happen.

Reference https://github.com/nhn/fe.javascript/blob/master/.github/contribute-by-reporting-issue.md https://github.com/witherview/witherview_frontend/issues/18

수정 & 찾아보기

• PR을 날릴때 Issue를 연동하기

• Project 만들기