Skip to content

story docs 양식 통일#952

Merged
hyoseong1994 merged 2 commits intomainfrom
937-integration-story-docs
Apr 8, 2026
Merged

story docs 양식 통일#952
hyoseong1994 merged 2 commits intomainfrom
937-integration-story-docs

Conversation

@hyoseong1994
Copy link
Copy Markdown
Contributor

@hyoseong1994 hyoseong1994 commented Apr 8, 2026

각 컴포넌트마다 JSDoc 주석의 형식이 제각각이었고, 인터페이스(interface)에서 이미 설명하고 있는 props를 컴포넌트 주석에서 다시 반복하는 경우가 다수 있었습니다.

  1. 인터페이스 중복 제거 — interface prop에 이미 JSDoc이 있는 경우 컴포넌트 주석에서 삭제
  2. 설명 톤 통일

테스팅

스크린샷 2026-04-08 오전 10 51 03

로컬에서 storybook 구동하여 확인하였습니다.

체크 리스트

  • 코드 리뷰를 요청하기 전에 반드시 CI가 통과하는지 확인해주세요.
  • 컴포넌트나 스토리 변경이 있는 경우 PR에 ui 태그를 달아주세요.
    • UI Tests를 통해 스냅샷 차이가 의도된 것인지 확인해주세요.
    • UI Review를 통해 디자이너에게 리뷰를 요청하고 승인을 받으세요.

@hyoseong1994 hyoseong1994 linked an issue Apr 8, 2026 that may be closed by this pull request
@hyoseong1994 hyoseong1994 changed the title 937 integration story docs story docs 양식 통일 Apr 8, 2026
@hyoseong1994 hyoseong1994 added the ui Chromatic label Apr 8, 2026
@hyoseong1994 hyoseong1994 marked this pull request as ready for review April 8, 2026 02:09
@hyoseong1994 hyoseong1994 requested a review from a team as a code owner April 8, 2026 02:09
Copy link
Copy Markdown
Member

@DaleSeo DaleSeo left a comment

Choose a reason for hiding this comment

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

깔끔하군요!

@hyoseong1994 hyoseong1994 added this pull request to the merge queue Apr 8, 2026
Merged via the queue into main with commit e35684d Apr 8, 2026
13 checks passed
@hyoseong1994 hyoseong1994 deleted the 937-integration-story-docs branch April 8, 2026 12:14
@RiaOh RiaOh mentioned this pull request Apr 8, 2026
4 tasks
This was referenced Apr 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ui Chromatic

Projects

None yet

Development

Successfully merging this pull request may close these issues.

story docs 양식 통일

3 participants