Skip to content

Revise bug template for better reporting #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
KateteDeveloper wants to merge 1 commit into from
Closed

Revise bug template for better reporting #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 26 additions & 18 deletions .github/ISSUE_TEMPLATE/bug-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,26 @@
---
name: Bug Template
about: ๋ฒ„๊ทธ ์ œ๋ณด๋ฅผ ์œ„ํ•œ ํ…œํ”Œ๋ฆฟ
title: 'Bug: ์ œ๋ชฉ์„ ์ ์–ด์ฃผ์„ธ์š”'
labels: ''
assignees: ''

---

## :bug: ์„ค๋ช…
> ๋ฒ„๊ทธ๊ฐ€ ๋ฐœ์ƒํ•˜๋Š” ์ƒํ™ฉ์— ๋Œ€ํ•œ ์„ค๋ช…์„ ์ž์„ธํžˆ ์ ์–ด์ฃผ์„ธ์š”.
> ํ•ด๋‹น ์ƒํ™ฉ์„ ์บก์ฒ˜ํ•˜์—ฌ ์ฒจ๋ถ€ํ•  ์ˆ˜ ์žˆ๋‹ค๋ฉด ์ข‹์Šต๋‹ˆ๋‹ค.

## :bulb: ์˜ˆ์ƒ ์›์ธ
> ๋ฒ„๊ทธ์˜ ์›์ธ์„ ์˜ˆ์ƒํ•  ์ˆ˜ ์žˆ๋‹ค๋ฉด ์ ์–ด์ฃผ์„ธ์š”.

## :calendar: ๊ธฐํ•œ
> ๊ธฐํ•œ์ด ์„ค์ •๋œ ๊ฒฝ์šฐ ์ ์–ด์ฃผ์„ธ์š”.
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
Comment on lines +1 to +26
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 26, 2026

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.