Skip to content

CodeHiker Issue 작성 가이드

MrKeeplearning edited this page Jan 7, 2023 · 2 revisions

Issue 작성 가이드

새로운 기능을 추가하거나 발생한 버그를 해결하는 것과 같이 하나의 작업을 단위로 이슈를 생성합니다.

제목

어떤 작업인지 이해하기 쉽도록 하나의 완결된 문장으로 작성한다.

본문

Issue를 생성할 때 관련된 템플릿에 맞추어 issue를 생성합니다.

Feature request

## ✅ 구현할 기능

구현할 기능에 대해서 설명해주세요.

## ⌨️ 상세 작업 내용

- [ ] To do 1
- [ ] To do 2
- [ ] To do 3

## 💡 참고 사항

참고 사항이 없다면 삭제한 후 작성해주세요.

Bug report

## 🐞 버그 내용

버그에 대한 명확하고 간결한 설명

## ⏪ 버그 재현 방법

버그가 발생하려면 어떤 상황을 만들어야 하는지 단계 별로 설명
1. '...'로 이동
2. '...'에서 무엇을 클릭
3. 로그에서 몇 번째 라인을 보면...

## 💻 기대되는 상태

위의 단계를 실행했을 때 출력되어야 하는 결과에 대한 명확하고 간결한 설명

## 📸 스크린샷

문제 해결에 도움이 될 수 있는 스크린샷 첨부

## 💡 참고 사항

문제에 대한 부가적인 설명 또는 참고 사항