이는 Discourse에서 버그를 수정받을 확률을 높이기 위해 효과적인 버그 리포트를 작성하는 가이드입니다.
필요한 사용자 권한: 누구나 버그를 보고할 수 있음
양질의 버그 리포트를 작성하는 것은 Discourse 팀이 문제를 효율적으로 해결하는 데 필수적입니다. 이 가이드는 버그 리포트가 명확하고 간결하며 실행 가능하도록 만드는 단계와 모범 사례를 안내해 드립니다.
요약
이 문서에서는 다음 내용을 다룹니다:
- 재현 가능한 단계와 구체적인 세부 정보를 제공하는 것의 중요성
- 문제와 예상 동작을 설명하는 방법
- 다양한 플랫폼에서 보고할 때의 모범 사례
- 보고서에서 적절한 톤을 유지하는 방법
- 일반적인 함정 및 해결 방법
효과적인 버그 리포트 작성 단계
우선순위/심각도
버그 수정의 시급성을 결정하세요. 모든 사용자는 자신의 문제가 빨리 해결되기를 원하지만, 기능에 중대한 영향을 미치는 심각한 문제에 대해서만 최상위 우선순위를 사용해야 합니다.
플랫폼
버그가 관찰된 환경을 항상 명시하세요. 여기에는 다음이 포함됩니다:
- 장치 유형 (데스크톱, 모바일, 터치스크린, 태블릿)
- 운영체제 및 버전
- 웹 브라우저 및 버전
가능한 경우, 버그가 존재하는지 확인하기 위해 여러 플랫폼에서 버그를 재현해 보세요.
설명
간결하게 작성하세요. 불필요한 세부 사항 없이 문제를 간단히 설명하세요. 개별적으로 보고할 수 있는 경우 다른 문제들을 분리하세요. 명확한 설명 형식은 다음과 같습니다:
실제 결과: 현재 어떤 일이 일어나고 있나요?
예상 결과: 어떤 일이 일어나야 했나요?
독자가 이미 알고 있다고 가정하지 마세요. 무엇이 보여야 하거나 발생해야 했는지 명시적으로 설명하세요.
재현 가능한 단계
버그가 일관되게 재현될 수 있는지 확인하세요. Discourse의 홈 화면부터 시작하는 단계별 지침을 작성하세요. 버그가 무작위로 발생한다면, 얼마나 자주 발생하는지 지정하세요 (예: 10회 시도 중 1회). UI/UX 관련 버그의 경우, 명확성을 위해 스크린샷이나 비디오를 추가하세요.
톤
존중하고 정중한 톤을 유지하세요. 버그 리포트를 통해 불만을 표현하는 것은 피하세요. 독한 언어나 행동은 보고서가 지연되거나 무시되는 결과를 초래할 수 있습니다.
템플릿
새로운 버그 리포트 주제를 빠르게 시작하려면 이 템플릿을 사용하세요:
우선순위/심각도:
플랫폼:
설명:
재현 가능한 단계:
모범 사례
- 안전 모드에서 재현하기: 커스터마이징이 원인이 될 수 있다고 의심되는 경우, 보고하기 전에 Discourse의 안전 모드에서 문제를 재현해 보세요.
- 가정 질문하기: 버그 리포트는 종종 잘못된 가정에서 비롯됩니다. 보고서에서도 자신의 가정을 질문하고 명확히 하세요.
- 세부적으로 작성하기: 찾기 어렵거나 드문 버그의 경우, 가능한 한 많은 세부 정보를 제공하세요. 에러 메시지나 로그 파일 등 관련이 있을 수 있는 모든 것을 포함하세요.
일반적인 문제 및 해결 방법
문제: 버그를 일관되게 재현할 수 없음.
해결 방법: 버그가 나타나는 환경과 조건을 문서화하세요. 패턴이나 공통점을 기록하세요.
문제: 버그 리포트에 대한 응답 없음.
해결 방법: 보고서가 상세하지만 간결하며 정중한 톤으로 작성되었는지 확인하세요.
자주 묻는 질문
질문: 상세한 리포트를 작성할 시간이 없다면 어떻게 하나요?
답: 현재 가지고 있는 정보로 리포트를 여는 것이 여전히 도움이 됩니다. 나중에 더 많은 세부 정보로 업데이트할 것이라고 명시하세요.
질문: 버그 리포트를 어디에 게시해야 하나요?
답: 적절한 카테고리를 사용하세요 - 버그 리포트는 Contribute > Bug 카테고리에 있어야 합니다.