Skip to content
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.

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

fix: Issue Template Parsing Issue #99

Merged
merged 2 commits into from
Jan 13, 2025
Merged

Conversation

SEMIN-97
Copy link
Contributor

@SEMIN-97 SEMIN-97 commented Jan 12, 2025

Changes

템플릿 상단에 하이픈이 빠져 YAML 문법을 인식하지 못하는 문제가 있어 수정하였습니다.

Visuals

Checklist

  • Have you written the functional specifications?
  • Have you written the test code?

Additional Discussion Points

Summary by CodeRabbit

  • 문서
    • 버그 보고서 템플릿에 이름과 설명 추가
    • 새로운 컴포넌트 설계 이슈 템플릿 생성

이 변경사항은 GitHub 이슈 템플릿을 개선하여 더 명확하고 구조화된 이슈 작성을 지원합니다.

@SEMIN-97 SEMIN-97 added the documentation Improvements or additions to documentation label Jan 12, 2025
Copy link

changeset-bot bot commented Jan 12, 2025

⚠️ No Changeset found

Latest commit: ac0dc8c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

coderabbitai bot commented Jan 12, 2025

워크스루

이 풀 리퀘스트는 GitHub 이슈 템플릿에 대한 두 가지 주요 변경 사항을 포함하고 있습니다. 첫째, 버그 보고서 템플릿에 YAML 프론트 매터를 추가하여 템플릿의 이름과 설명을 명시했습니다. 둘째, 컴포넌트 설계 템플릿을 완전히 새로운 구조로 대체하여 더 체계적인 컴포넌트 설계 가이드라인을 제공합니다.

변경 사항

파일 변경 요약
.github/ISSUE_TEMPLATE/bug_report.md YAML 프론트 매터 추가: 이름을 "Bug Report"로, 설명을 "Report a bug"로 지정, 레이블 추가: "bug"
.github/ISSUE_TEMPLATE/component_design.md 컴포넌트 설계를 위한 새로운 템플릿 구조 도입, 레이블 추가: "enhancement"

가능한 관련 PR

제안된 리뷰어

  • bae-sh
  • heeji289
  • synuns
  • yeojini
  • hy57in
  • kimdaeyeobbb
  • froggy1014
  • developerjhp
  • noahluftyang

🐰 이슈 템플릿, 반짝반짝
버그와 설계 길을 밝히네
명확한 가이드 한 줄로
개발의 꽃을 피워내네
코드의 토끼, 재잘재잘 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Jan 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

@@ -1,6 +1,6 @@
---
name: "Bug Report"
Copy link
Contributor

Choose a reason for hiding this comment

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

라벨까지 추가하면 좋을 것 같아

Copy link

@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: 0

🧹 Nitpick comments (1)
.github/ISSUE_TEMPLATE/bug_report.md (1)

Line range hint 1-50: 템플릿 구조 개선을 위한 제안

버그 리포트 템플릿의 구조를 더욱 개선하기 위해 다음 사항들을 고려해보시는 것은 어떨까요?

  1. 우선순위나 심각도를 나타내는 필드 추가
  2. 관련된 이슈나 PR을 연결할 수 있는 섹션 추가
  3. 재현 빈도를 표시할 수 있는 필드 추가

다음과 같이 YAML 프론트매터를 확장할 수 있습니다:

 ---
 name: "Bug Report"
 about: "Report a bug"
 labels: "bug"
+title: "[Bug] "
+assignees: ""
+projects: ""
 ---

그리고 템플릿 본문에 다음 섹션을 추가하는 것을 고려해보세요:

## 우선순위 (Priority)
<!--
버그의 우선순위를 표시해주세요:
- Critical (긴급)
- High (높음)
- Medium (중간)
- Low (낮음)
-->

## 관련 이슈/PR
<!--
이 버그와 관련된 이슈나 PR이 있다면 링크해주세요.
-->

## 재현 빈도
<!--
버그가 얼마나 자주 발생하는지 표시해주세요:
- 항상 (100%)
- 자주 (75%)
- 가끔 (50%)
- 드물게 (25%)
-->
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 765c5e0 and ac0dc8c.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/bug_report.md (1 hunks)
  • .github/ISSUE_TEMPLATE/component_design.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/ISSUE_TEMPLATE/component_design.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: chromatic
🔇 Additional comments (1)
.github/ISSUE_TEMPLATE/bug_report.md (1)

1-4: YAML 구문이 올바르게 수정되었습니다! 👍

YAML 프론트매터가 올바르게 추가되었고, 이전 리뷰에서 제안된 대로 라벨도 포함되어 있습니다.

@noahluftyang noahluftyang merged commit 2883086 into main Jan 13, 2025
6 of 7 checks passed
@noahluftyang noahluftyang deleted the docs/fix-issue-template branch January 13, 2025 02:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants