Skip to content

Revise bug template for better reporting#96

Open
KateteDeveloper wants to merge 1 commit intodevelopfrom
KateteDeveloper-patch-1
Open

Revise bug template for better reporting#96
KateteDeveloper wants to merge 1 commit intodevelopfrom
KateteDeveloper-patch-1

Conversation

@KateteDeveloper
Copy link
Copy Markdown
Collaborator

@KateteDeveloper KateteDeveloper commented Mar 26, 2026

Updated bug report template to improve clarity and usability.

📝 설명

해당 PR이 진행한 사항을 자세히 적어주세요.

✔️ PR 유형

어떤 변경 사항이 있나요?

  • 새로운 기능 추가
  • 버그 수정
  • CSS 등 사용자 UI 디자인 변경
  • 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
  • 코드 리팩토링
  • 주석 추가 및 수정
  • 문서 수정
  • 테스트 추가, 테스트 리팩토링
  • 빌드 부분 혹은 패키지 매니저 수정
  • 파일 혹은 폴더명 수정
  • 파일 혹은 폴더 삭제

📎 관련 이슈 번호

해당 PR과 관련된 이슈 번호를 적어주세요.

Summary by CodeRabbit

Chores

  • 버그 신고 양식 개선
    • 버그 신고 양식이 더욱 명확하고 체계적인 구조의 폼 형식으로 업그레이드되었습니다.
    • 이전 버그 신고 여부를 확인하는 필수 체크박스 필드가 추가되었습니다.
    • 버그 상황에 대한 상세한 설명 입력을 위한 필수 텍스트 입력 필드가 추가되었습니다.

Updated bug report template to improve clarity and usability.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 26, 2026

개요

GitHub 버그 리포트 이슈 템플릿이 레거시 마크다운 섹션 기반 형식에서 구조화된 이슈 폼으로 변환되었습니다. 템플릿 메타데이터가 업데이트되고 폼 본문에 필수 필드가 추가되었습니다.

변경 사항

작업군 / 파일 요약
GitHub 이슈 템플릿
.github/ISSUE_TEMPLATE/bug-template.md
이슈 템플릿 구조를 마크다운 형식에서 YAML 기반 폼 스키마로 변환. 메타데이터 업데이트(name: 'Bug Template' → 'Bug Report', title: '[Bug]: ' 프리픽스, labels: '버그' 추가) 및 필수 필드 추가(id: duplicated-check 체크박스, id: what-happened 텍스트 영역)

예상 코드 리뷰 노력

🎯 2 (Simple) | ⏱️ ~10분

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 풀 리퀘스트 제목은 버그 템플릿 개선이라는 변경의 핵심을 명확하게 반영하고 있습니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch KateteDeveloper-patch-1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/ISSUE_TEMPLATE/bug-template.md:
- Around line 1-26: Rename the Issue Form file from .md to a .yml/.yaml
extension so GitHub treats it as an Issue Form (locate the file by searching for
the block containing "name: Bug Report" and "title: \"[Bug]: \"). Ensure the
file name ends with .yml or .yaml (for example bug-report.yml), keep the
existing YAML keys (name, description, title, labels, body, etc.) intact and
valid YAML, and verify indentation/quoting is correct so GitHub can parse the
form.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f6d6810b-cf40-4d10-95a5-93c77bb598c0

📥 Commits

Reviewing files that changed from the base of the PR and between d95222d and 62c37fa.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/bug-template.md

Comment on lines +1 to +26
name: Bug Report
description: Create a report to help us improve
title: "[Bug]: "
labels: "버그"
body:
- type: markdown
attributes:
value: |
버그 제보를 해주세요
- type: checkboxes
id: duplicated-check
attributes:
label: 이미 제보된 버그인가요?
description: 이미 제보된 Issue 인지 확인해주세요!
options:
- label: 제보된 버그인 지 찾아봤습니다.
required: true
- type: textarea
id: what-happened
attributes:
label: 무슨 버그인가요?
description: 기대되는 동작은 무엇인지 설명해주세요
placeholder: 버그에 대해서 설명해주세요!
value: "A bug happened!"
validations:
required: true
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🌐 Web query:

GitHub Issue Forms는 .github/ISSUE_TEMPLATE 내에서 .md 파일도 YAML body 스키마(name/description/body)를 지원하나요, 아니면 .yml/.yaml만 지원하나요? 공식 문서 기준으로 확장자 요구사항과 예시를 확인해 주세요.

💡 Result:

GitHub Issue Forms는 .github/ISSUE_TEMPLATE 폴더에서 .yml 또는 .yaml 확장자를 가진 파일만 지원합니다. .md 파일은 일반 Markdown issue template으로 사용되며, YAML body 스키마(name/description/body)를 가진 issue form으로는 지원되지 않습니다. 공식 문서에 따르면: - Issue forms는 "YAML form definition file"을 .github/ISSUE_TEMPLATE에 추가해야 하며, 모든 예시가 .yml로 제시됩니다. (Syntax for issue forms) - 생성 지침: ".github/ISSUE_TEMPLATE/FORM-NAME.yml" 파일 생성. (Configuring issue templates) - 명시적 구분: "Issue templates created with issue forms need a .yml extension." Markdown templates는 .md extension 필요. (About issue and pull request templates) - Markdown template을 issue form으로 변환 시 "new YAML file을 생성해야 하며", 동일 파일명 사용 시 기존 .md 삭제 필요. .md에서 YAML form 직접 지원 안 함. 따라서 YAML body 스키마를 사용한 issue forms는 .yml/.yaml만 지원하며, .md는 YAML frontmatter를 가진 legacy template으로 별도 처리됩니다.

Citations:


이 파일의 확장자를 .yml 또는 .yaml로 변경해야 합니다.

현재 .md 확장자로는 GitHub Issue Forms가 작동하지 않습니다. GitHub Issue Forms는 .yml 또는 .yaml 확장자를 가진 파일만 지원하며, .md 파일은 기존의 마크다운 템플릿으로만 처리됩니다. 따라서 파일을 .github/ISSUE_TEMPLATE/bug-report.yml로 변경하세요.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/ISSUE_TEMPLATE/bug-template.md around lines 1 - 26, Rename the Issue
Form file from .md to a .yml/.yaml extension so GitHub treats it as an Issue
Form (locate the file by searching for the block containing "name: Bug Report"
and "title: \"[Bug]: \"). Ensure the file name ends with .yml or .yaml (for
example bug-report.yml), keep the existing YAML keys (name, description, title,
labels, body, etc.) intact and valid YAML, and verify indentation/quoting is
correct so GitHub can parse the form.

@ugmin1030 ugmin1030 self-requested a review March 26, 2026 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants