Revise feature issue template for clarity and format#97
Open
KateteDeveloper wants to merge 1 commit intodevelopfrom
Open
Revise feature issue template for clarity and format#97KateteDeveloper wants to merge 1 commit intodevelopfrom
KateteDeveloper wants to merge 1 commit intodevelopfrom
Conversation
Updated the feature issue template to a new format with improved descriptions and structure.
WalkthroughGitHub 이슈 템플릿을 YAML front-matter 기반의 마크다운 체크리스트 형식에서 GitHub Issue Forms의 YAML 기반 구조로 전환했습니다. 템플릿의 메타데이터, 제목, 라벨이 변경되었으며, 본문 구조가 폼 컴포넌트로 재구성되었습니다. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
.github/ISSUE_TEMPLATE/feature-template.md (3)
15-16: 기능 설명 필드가 선택 사항으로 설정되어 있습니다.유일한 기능 설명 필드가
required: false로 설정되어 있어 사용자가 내용 없이 이슈를 제출할 수 있습니다. 최소한의 기능 설명은 필수로 요구하는 것이 좋습니다.♻️ 제안하는 수정
validations: - required: false + required: true🤖 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 15 - 16, 현재 ISSUE 템플릿의 기능 설명 필드가 validations: required: false로 되어 있어 빈 내용으로 이슈를 제출할 수 있습니다; templates의 해당 블록(키명 "validations" 및 하위키 "required")을 수정해 required: true로 변경하고(필요하면 minLength나 placeholder 설명도 추가) 기능 설명 필드를 필수로 만드세요.
5-16: 기능 요청 템플릿이 너무 간소합니다.현재 템플릿은 단일 텍스트 영역만 포함하고 있어 효과적인 기능 요청을 수집하기에 부족합니다. 일반적인 기능 요청 템플릿은 다음 정보를 포함합니다:
- 문제 상황 또는 동기 (왜 이 기능이 필요한가?)
- 제안하는 해결 방법
- 고려한 대안들
- 추가 컨텍스트 (스크린샷, 참고 자료 등)
💡 개선된 템플릿 구조 제안
body: - type: markdown attributes: value: | - 새로운 기능에 대해서 설명해주세요. + ## 기능 제안 + 새로운 기능에 대해 자세히 설명해주세요. + - type: textarea - id: context + id: problem attributes: - label: 기능 - description: 어떤 기능인가요? + label: 문제 상황 또는 동기 + description: 이 기능이 왜 필요한가요? 어떤 문제를 해결하나요? + placeholder: 예) 사용자가 ~를 할 때 ~하는 기능이 없어서 불편합니다. + validations: + required: true + + - type: textarea + id: solution + attributes: + label: 제안하는 해결 방법 + description: 어떻게 이 문제를 해결하시겠습니까? + placeholder: 예) ~하는 기능을 추가하여 ~를 개선합니다. validations: - required: false + required: true + + - type: textarea + id: alternatives + attributes: + label: 고려한 대안들 + description: 다른 해결 방법을 고려해보셨나요? + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: 추가 컨텍스트 + description: 스크린샷, 참고 자료 등을 추가해주세요. + validations: + required: false🤖 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, Update the feature request issue template to expand beyond the single textarea (currently defined under body -> type: textarea with id: context and label: 기능) by adding separate fields for "Problem / Motivation", "Proposed Solution", "Alternatives Considered", and "Additional Context (screenshots, links)" each as textarea blocks with appropriate labels and validations.required where applicable; retain the original context field if desired but rename or re-label it for general notes, and ensure the overall YAML under body preserves existing structure and attributes so GitHub will render all sections in the issue form.
1-4: 메타데이터 언어 일관성을 고려해보세요.메타데이터 필드들이 영어와 한국어가 혼용되어 있습니다:
name과description: 영어title: 영어 형식 + 한국어 라벨 혼합labels: 한국어프로젝트가 한국어 중심이라면 메타데이터도 한국어로 통일하는 것을 고려해보세요.
♻️ 한국어 통일 제안
-name: Feature request -description: Suggest an idea for this project -title: "[Feature]: " +name: 기능 제안 +description: 프로젝트에 대한 아이디어를 제안해주세요 +title: "[기능]: " labels: "기능"🤖 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 - 4, The metadata fields in the feature template are inconsistent between English and Korean (fields: name, description, title, labels); update these to a single language—e.g., translate and replace name and description with Korean equivalents (e.g., 이름, 설명), ensure title uses a Korean-friendly prefix, and make labels consistent (e.g., 모두 한국어) so all metadata keys and values follow the same language convention.
🤖 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/feature-template.md:
- Around line 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.
- Around line 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.
---
Nitpick comments:
In @.github/ISSUE_TEMPLATE/feature-template.md:
- Around line 15-16: 현재 ISSUE 템플릿의 기능 설명 필드가 validations: required: false로 되어 있어
빈 내용으로 이슈를 제출할 수 있습니다; templates의 해당 블록(키명 "validations" 및 하위키 "required")을 수정해
required: true로 변경하고(필요하면 minLength나 placeholder 설명도 추가) 기능 설명 필드를 필수로 만드세요.
- Around line 5-16: Update the feature request issue template to expand beyond
the single textarea (currently defined under body -> type: textarea with id:
context and label: 기능) by adding separate fields for "Problem / Motivation",
"Proposed Solution", "Alternatives Considered", and "Additional Context
(screenshots, links)" each as textarea blocks with appropriate labels and
validations.required where applicable; retain the original context field if
desired but rename or re-label it for general notes, and ensure the overall YAML
under body preserves existing structure and attributes so GitHub will render all
sections in the issue form.
- Around line 1-4: The metadata fields in the feature template are inconsistent
between English and Korean (fields: name, description, title, labels); update
these to a single language—e.g., translate and replace name and description with
Korean equivalents (e.g., 이름, 설명), ensure title uses a Korean-friendly prefix,
and make labels consistent (e.g., 모두 한국어) so all metadata keys and values follow
the same language convention.
🪄 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: 16e9b759-b68d-445c-94ba-7752507506f2
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/feature-template.md
Comment on lines
+1
to
+16
| 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 |
There was a problem hiding this comment.
🧩 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:
- 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/common-validation-errors-when-creating-issue-forms
- 3: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
- 4: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
- 5: https://docs.github.com/en/enterprise-cloud@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository
파일 확장자가 잘못되었습니다 - 템플릿이 작동하지 않습니다
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
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| 새로운 기능에 대해서 설명해주세요. | ||
| - type: textarea | ||
| id: context | ||
| attributes: | ||
| label: 기능 | ||
| description: 어떤 기능인가요? | ||
| validations: | ||
| required: false |
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated the feature issue template to a new format with improved descriptions and structure.
📝 설명
✔️ PR 유형
어떤 변경 사항이 있나요?
📎 관련 이슈 번호
Summary by CodeRabbit
Chores