Revise bug template for better reporting#96
Conversation
Updated bug report template to improve clarity and usability.
개요GitHub 버그 리포트 이슈 템플릿이 레거시 마크다운 섹션 기반 형식에서 구조화된 이슈 폼으로 변환되었습니다. 템플릿 메타데이터가 업데이트되고 폼 본문에 필수 필드가 추가되었습니다. 변경 사항
예상 코드 리뷰 노력🎯 2 (Simple) | ⏱️ ~10분 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/bug-template.md
| 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 |
There was a problem hiding this comment.
🧩 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:
- 1: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
- 2: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
- 3: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
- 4: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository
- 5: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates
이 파일의 확장자를 .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.
Updated bug report template to improve clarity and usability.
📝 설명
✔️ PR 유형
어떤 변경 사항이 있나요?
📎 관련 이슈 번호
Summary by CodeRabbit
Chores