Skip to content

Revise feature issue template for clarity and format #97

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

Open
KateteDeveloper wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Revise feature issue template for clarity and format #97

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
35 changes: 16 additions & 19 deletions .github/ISSUE_TEMPLATE/feature-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
---
name: Feature Template
about: κΈ°λŠ₯ μΆ”κ°€λ₯Ό μœ„ν•œ 이슈 ν…œν”Œλ¦Ώ
title: 'Feature: 제λͺ©μ„ μ μ–΄μ£Όμ„Έμš”'
labels: ''
assignees: ''

---

## :sparkles: μ„€λͺ…
> κΈ°λŠ₯에 λŒ€ν•œ μžμ„Έν•œ μ„€λͺ…을 μ μ–΄μ£Όμ„Έμš”.

## :pushpin: ν•΄μ•Ό ν•  일
- [ ] κΈ°λŠ₯ κ΅¬ν˜„μ„ μœ„ν•΄
- [ ] ν•΄μ•Ό ν•  일듀을
- [ ] μ μ–΄μ£Όμ„Έμš”.

## :calendar: κΈ°ν•œ
> κΈ°ν•œμ΄ μ„€μ •λœ 경우 μ μ–΄μ£Όμ„Έμš”.
name: Feature request
description: Suggest an idea for this project
title: "[Feature]: "
labels: "κΈ°λŠ₯"
body:
- type: markdown
attributes:
value: |
μƒˆλ‘œμš΄ κΈ°λŠ₯에 λŒ€ν•΄μ„œ μ„€λͺ…ν•΄μ£Όμ„Έμš”.
- type: textarea
id: context
attributes:
label: κΈ°λŠ₯
description: μ–΄λ–€ κΈ°λŠ₯μΈκ°€μš”?
validations:
required: false
Comment on lines +1 to +16
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 file extension requirements

πŸ’‘ Result:

GitHub Issue Forms require YAML files with a .yml extension placed in the .github/ISSUE_TEMPLATE/ directory of the repository's default branch. Filenames are not case-sensitive and can be prefixed with numbers for ordering (e.g., bug-report.yml). The config.yml file in the same directory uses the same extension. While YAML parsers accept both .yml and .yaml, official documentation consistently uses and exemplifies .yml for issue forms, and templates are grouped by filetype with YAML files before Markdown. There are no strict requirements on other file extensions; any .yml file in that directory is recognized as an issue form if it has valid syntax (starting with name, description, body). Markdown templates use .md. For file uploads within issue forms (type: upload), supported extensions include images (.png, .jpg, etc. up to 10MB), videos (.mp4 etc. up to 100MB), documents (.pdf, .docx etc. 25MB), archives (.zip 25MB), with optional 'accept' attribute to restrict (comma-separated list like ".png,.jpg").

Citations:

파일 ν™•μž₯μžκ°€ 잘λͺ»λ˜μ—ˆμŠ΅λ‹ˆλ‹€ - ν…œν”Œλ¦Ώμ΄ μž‘λ™ν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€

GitHub Issue FormsλŠ” .yml ν™•μž₯자λ₯Ό μ‚¬μš©ν•΄μ•Ό ν•©λ‹ˆλ‹€. ν˜„μž¬ 파일λͺ…이 feature-template.md둜 λ˜μ–΄ μžˆμ–΄ 이 ν…œν”Œλ¦Ώμ΄ μ •μƒμ μœΌλ‘œ μž‘λ™ν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€. νŒŒμΌμ„ .github/ISSUE_TEMPLATE/feature-template.yml둜 λ³€κ²½ν•˜μ„Έμš”.

πŸ€– Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.github/ISSUE_TEMPLATE/feature-template.md around lines 1 - 16, Rename the
issue template file from feature-template.md to feature-template.yml so GitHub
Issue Forms recognizes it; specifically change the filename
"feature-template.md" to "feature-template.yml" and ensure the existing
YAML-formatted content (name, description, title, labels, body, validations)
remains valid YAML after the rename.

Comment on lines +5 to +16
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 | 🟠 Major

PR μ„€λͺ…κ³Ό μ‹€μ œ κ΅¬ν˜„ λ‚΄μš©μ΄ μΌμΉ˜ν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€.

PR λͺ©ν‘œμ—λŠ” λ‹€μŒ μ„Ήμ…˜λ“€μ΄ ν¬ν•¨λœλ‹€κ³  λͺ…μ‹œλ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€:

  • "μ„€λͺ…" μ„Ήμ…˜ (PR μž‘μ—…μ— λŒ€ν•œ 상세 μ„€λͺ…)
  • "PR μœ ν˜•" 체크리슀트 (μ‹ κ·œ κΈ°λŠ₯, 버그 μˆ˜μ •, UI/λ””μžμΈ λ“±)
  • "κ΄€λ ¨ 이슈 번호" μ„Ήμ…˜

ν•˜μ§€λ§Œ μ‹€μ œ ν…œν”Œλ¦Ώμ—λŠ” λ§ˆν¬λ‹€μš΄ 블둝 ν•˜λ‚˜μ™€ "κΈ°λŠ₯" ν…μŠ€νŠΈ μ˜μ—­ ν•˜λ‚˜λ§Œ ν¬ν•¨λ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€. λ˜ν•œ PR λͺ©ν‘œμ— μ„€λͺ…λœ λ‚΄μš©μ€ PR ν…œν”Œλ¦Ώ κΈ°λŠ₯처럼 λ³΄μ΄μ§€λ§Œ, 이 νŒŒμΌμ€ 이슈 ν…œν”Œλ¦Ώμž…λ‹ˆλ‹€.

πŸ€– Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.github/ISSUE_TEMPLATE/feature-template.md around lines 5 - 16, The issue is
that the issue template's YAML body (fields like the markdown block and the
textarea with id: context and label: κΈ°λŠ₯) does not match the PR description
requirements; update this template so it either becomes an Issue template that
only asks issue-appropriate fields or convert/create a separate PR template with
the required fields: a "μ„€λͺ…" markdown/textarea for detailed description, a "PR
μœ ν˜•" checklist field (μ‹ κ·œ κΈ°λŠ₯, 버그 μˆ˜μ •, UI/λ””μžμΈ, etc.), and a "κ΄€λ ¨ 이슈 번호" field; modify
the body section (replace or extend the existing type: markdown block and the
textarea id: context) to include these new elements and ensure validations
(required where appropriate) so the UI renders the PR-oriented sections
correctly.