-
Notifications
You must be signed in to change notification settings - Fork 51
Open
Labels
chore:systemIssue or PR regarding source environment (e.g. lints, tests), not the actual source codeIssue or PR regarding source environment (e.g. lints, tests), not the actual source codepriority:BIssue that important but not urgentIssue that important but not urgenttestIssue or PR that related to testIssue or PR that related to test
Description
Description
Storybook의 스토리를 작성하는 방식을 라이브러리 전반적으로 통일합니다.
Reasons for suggestion
- 스토리 작성 방식이 각자 달라 일관적이지 않습니다. 예를 들어, 어떤 컴포넌트는 Primary(
(arg) => <Foo {...args} />
)만 있고 어떤 컴포넌트는 몇몇 속성이 fixed 되어있습니다. 스토리북을 사용하는 사용자는 비개발직군(디자이너)도 될 수 있으므로, 일관적인 사용 경험을 제공하는 게 더욱 중요합니다. - 문서화 정도가 제각각입니다. Playground 정도만 제공할지, Write documentation #983 처럼 상세한 Documentation을 제공할 지 다시 판단해보면 좋을 거 같습니다.
Proposed solution
- 적절한 레퍼런스 리서치
- 스토리 작성 방식 통일
References
- Implement Component Template Feature #849 의 선행작업
- Upgrade from Storybook
6.x
to7.0
#1255 스토리 포맷을 신경쓸 것 - Improve Storybook docs structure by hide or disable controls of internal-use Stories #1083
- Enhance Chromatic UI snapshot test #1000
- Enhancement a11y test #995
- Unify the way writing unit tests #1330 과 관련하여 인터랙션 테스트에 대한 책임을 스토리북으로 옮길 지 판단
- Adobe Spectrum
- Carbon Design System: 일관적이고 좋다고 생각. Playground + fixed된 템플릿을 제공하는 방식이 좋아보임
- https://v7-react.carbondesignsystem.com/?path=/story/getting-started--using-the-storybook
- Docs 도 함께 제공하는데, 살펴보기
- 한글/영문으로 작성
- https://storybook.js.org/showcase
Metadata
Metadata
Assignees
Labels
chore:systemIssue or PR regarding source environment (e.g. lints, tests), not the actual source codeIssue or PR regarding source environment (e.g. lints, tests), not the actual source codepriority:BIssue that important but not urgentIssue that important but not urgenttestIssue or PR that related to testIssue or PR that related to test