Skip to content

๐Ÿ› Fix: prop-types ์ œ๊ฑฐํ•˜๊ณ  jsdoc ์ ์šฉํ•˜๊ธฐ#162

Merged
aahreum merged 3 commits intomainfrom
feature/badge
Oct 13, 2025
Merged

๐Ÿ› Fix: prop-types ์ œ๊ฑฐํ•˜๊ณ  jsdoc ์ ์šฉํ•˜๊ธฐ#162
aahreum merged 3 commits intomainfrom
feature/badge

Conversation

@heoc0523
Copy link
Contributor

๐Ÿ”— ์ด์Šˆ ๋ฒˆํ˜ธ

โœจ ์ž‘์—…ํ•œ ๋‚ด์šฉ

๊ด€๊ณ„ & ์ด๋ชจ์ง€ ๋ฑƒ์ง€ ์ปดํฌ๋„ŒํŠธ prop-types ์ œ๊ฑฐํ•˜๊ณ  jsdoc ์ ์šฉํ•˜๊ธฐ

@vercel
Copy link

vercel bot commented Oct 13, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
frontend Ready Ready Preview Comment Oct 13, 2025 3:52pm

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @heoc0523, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

์ด PR์€ EmojiBadge ๋ฐ RelationshipBadge ์ปดํฌ๋„ŒํŠธ์˜ ์ฝ”๋“œ ์ •๋ฆฌ๋ฅผ ๋ชฉํ‘œ๋กœ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ์กด์— ์‚ฌ์šฉํ•˜๋˜ prop-types ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋ฅผ ์ œ๊ฑฐํ•˜๊ณ , ๋Œ€์‹  JSDoc์„ ์‚ฌ์šฉํ•˜์—ฌ ์ปดํฌ๋„ŒํŠธ์˜ props๋ฅผ ๋ฌธ์„œํ™”ํ•จ์œผ๋กœ์จ ์™ธ๋ถ€ ์˜์กด์„ฑ์„ ์ค„์ด๊ณ  ์ฝ”๋“œ ๊ฐ€๋…์„ฑ์„ ํ–ฅ์ƒ์‹œ์ผฐ์Šต๋‹ˆ๋‹ค. ์ด๋Š” ์ปดํฌ๋„ŒํŠธ์˜ ์œ ์ง€๋ณด์ˆ˜์„ฑ์„ ๋†’์ด๊ณ  ๊ฐœ๋ฐœ์ž๊ฐ€ props์˜ ์‚ฌ์šฉ๋ฒ•์„ ๋” ์‰ฝ๊ฒŒ ์ดํ•ดํ•  ์ˆ˜ ์žˆ๋„๋ก ๋•์Šต๋‹ˆ๋‹ค.

Highlights

  • prop-types ์ œ๊ฑฐ: EmojiBadge ๋ฐ RelationshipBadge ์ปดํฌ๋„ŒํŠธ์—์„œ prop-types ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ์˜์กด์„ฑ์„ ์ œ๊ฑฐํ–ˆ์Šต๋‹ˆ๋‹ค.
  • JSDoc ์ ์šฉ: ๋‘ ๋ฑƒ์ง€ ์ปดํฌ๋„ŒํŠธ์˜ props์— ๋Œ€ํ•œ ๋ฌธ์„œํ™”๋ฅผ ์œ„ํ•ด JSDoc ์ฃผ์„์„ ์ ์šฉํ–ˆ์Šต๋‹ˆ๋‹ค.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with ๐Ÿ‘ and ๐Ÿ‘Ž on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. โ†ฉ

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

์ด๋ฒˆ PR์€ prop-types๋ฅผ ์ œ๊ฑฐํ•˜๊ณ  JSDoc์„ ์ ์šฉํ•˜์—ฌ ์ปดํฌ๋„ŒํŠธ์˜ ํƒ€์ž…์„ ๋ช…์‹œํ•˜๋Š” ์ข‹์€ ๋ณ€๊ฒฝ์ž…๋‹ˆ๋‹ค. ์ „๋ฐ˜์ ์œผ๋กœ ์ž˜ ์ž‘์„ฑ๋˜์—ˆ์œผ๋ฉฐ, ๋ช‡ ๊ฐ€์ง€ ์‚ฌ์†Œํ•œ ์Šคํƒ€์ผ ๊ฐœ์„  ์‚ฌํ•ญ์„ ์ œ์•ˆํ•ฉ๋‹ˆ๋‹ค. JSDoc์—์„œ ๊ฐ์ฒด ํƒ€์ž…์„ ํ‘œ๊ธฐํ•  ๋•Œ Object ๋Œ€์‹  object๋ฅผ ์‚ฌ์šฉํ•˜๊ณ , ๋ถˆํ•„์š”ํ•œ ํŒŒ์ผ๋ช… ์ฃผ์„์„ ์ œ๊ฑฐํ•˜์—ฌ ์ฝ”๋“œ ๊ฐ€๋…์„ฑ์„ ๋†’์ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Comment on lines 1 to 2
// EmojiBadge.jsx
// ์ด๋ชจ์ง€ ๋ฑƒ์ง€ ์ปดํฌ๋„ŒํŠธ
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

ํŒŒ์ผ ์ตœ์ƒ๋‹จ์— ํŒŒ์ผ๋ช…์„ ์ฃผ์„์œผ๋กœ ์ถ”๊ฐ€ํ•  ํ•„์š”๋Š” ์—†์Šต๋‹ˆ๋‹ค. ํŒŒ์ผ๋ช…์ด ์ด๋ฏธ EmojiBadge.jsx์ด๋ฏ€๋กœ ์ด ์ฃผ์„์€ ๋ถˆํ•„์š”ํ•œ ์ •๋ณด๋ฅผ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ์กด์˜ ์ปดํฌ๋„ŒํŠธ ์„ค๋ช… ์ฃผ์„๋งŒ ๋‚จ๊ฒจ๋‘๋Š” ๊ฒƒ์ด ๋” ๊น”๋”ํ•ฉ๋‹ˆ๋‹ค.

Suggested change
// EmojiBadge.jsx
// ์ด๋ชจ์ง€ ๋ฑƒ์ง€ ์ปดํฌ๋„ŒํŠธ
// ์ด๋ชจ์ง€ ๋ฑƒ์ง€ ์ปดํฌ๋„ŒํŠธ

/**
* EmojiBadge ์ปดํฌ๋„ŒํŠธ
*
* @param {Object} props - ์ปดํฌ๋„ŒํŠธ props
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

JSDoc์—์„œ ๊ฐ์ฒด ํƒ€์ž…์„ ๋ช…์‹œํ•  ๋•Œ๋Š” Object ๋Œ€์‹  ์†Œ๋ฌธ์ž object๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ผ๋ฐ˜์ ์ธ ์ปจ๋ฒค์…˜์ž…๋‹ˆ๋‹ค. ์ผ๊ด€์„ฑ์„ ์œ„ํ•ด ์ˆ˜์ •ํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค.

Suggested change
* @param {Object} props - ์ปดํฌ๋„ŒํŠธ props
* @param {object} props - ์ปดํฌ๋„ŒํŠธ props

/**
* ๊ด€๊ณ„ ๋ฑƒ์ง€ ์ปดํฌ๋„ŒํŠธ
*
* @param {Object} props - ์ปดํฌ๋„ŒํŠธ ์†์„ฑ
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

JSDoc์—์„œ ๊ฐ์ฒด ํƒ€์ž…์„ ๋ช…์‹œํ•  ๋•Œ๋Š” Object ๋Œ€์‹  ์†Œ๋ฌธ์ž object๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ผ๋ฐ˜์ ์ธ ์ปจ๋ฒค์…˜์ž…๋‹ˆ๋‹ค. ์ผ๊ด€์„ฑ์„ ์œ„ํ•ด ์ˆ˜์ •ํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค.

Suggested change
* @param {Object} props - ์ปดํฌ๋„ŒํŠธ ์†์„ฑ
* @param {object} props - ์ปดํฌ๋„ŒํŠธ ์†์„ฑ

Copy link
Member

@aahreum aahreum left a comment

Choose a reason for hiding this comment

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

ํ™•์ธํ–ˆ์Šต๋‹ˆ๋‹ค!

@aahreum aahreum merged commit cb86364 into main Oct 13, 2025
2 of 3 checks passed
@aahreum aahreum deleted the feature/badge branch October 13, 2025 15:52
@github-actions
Copy link

๐ŸŽ‰ ๊ตฌํ˜„ํ•œ ๊ธฐ๋Šฅ Preview: https://frontend-aflvpgo93-fe-19-seongihuns-projects.vercel.app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants