Skip to content

Conversation

@quqjp
Copy link
Collaborator

@quqjp quqjp commented Dec 3, 2025

概要

  • EvaluationStarコンポーネントの仕様書を追加

変更内容

  • コンポーネントの仕様書を追加
  • props の説明記述
  • 合わせてStorybook Docsの更新
    • コード例の記載

quqjp added 2 commits December 3, 2025 08:47
- `docs/component/evaluation-star-specification.md:1` に EvaluationStar の仕様書を新規作成し、Props/状態/使用例/アクセシビリティ/注意事項/更新履歴をテンプレ順に整備しました(更新履歴はJST表記で記載)。
- `packages/component-ui/src/evaluation-star/Docs.mdx:1` で仕様書の埋め込み・Code Examples セクションを追加し、Storybook Docs から詳細仕様とサンプルコードを参照できるようにしました。
- `packages/component-ui/src/evaluation-star/evaluation-star.tsx:6` に Props 説明コメントを付与し、各プロパティの役割とデフォルト挙動をソース上で把握しやすくしました。
- `README.md:133` のコンポーネント一覧に Evaluation Star 仕様書へのリンクを追加し、索引から直接参照できるようにしました。

**テスト**
- 未実施(ドキュメントとコメントのみの変更のため)

必要に応じて `yarn storybook` で Docs.mdx の表示を確認してください。
@github-actions
Copy link

github-actions bot commented Dec 3, 2025

Chromatic results

Outputs

Name Value
storybookUrl https://639bcc36e4bdc7deb6496ad2-dhqcnugcyn.chromatic.com/
buildUrl https://www.chromatic.com/build?appId=639bcc36e4bdc7deb6496ad2&number=1530
actualCaptureCount 0
changeCount 3
errorCount 0

quqjp added 3 commits December 5, 2025 11:47
- `docs/component/evaluation-star-specification.md:1` に EvaluationStar の仕様書を新規作成し、Props/状態/使用例/アクセシビリティ/注意事項/更新履歴をテンプレ順に整備しました(更新履歴はJST表記で記載)。
- `packages/component-ui/src/evaluation-star/Docs.mdx:1` で仕様書の埋め込み・Code Examples セクションを追加し、Storybook Docs から詳細仕様とサンプルコードを参照できるようにしました。
- `packages/component-ui/src/evaluation-star/evaluation-star.tsx:6` に Props 説明コメントを付与し、各プロパティの役割とデフォルト挙動をソース上で把握しやすくしました。
- `README.md:133` のコンポーネント一覧に Evaluation Star 仕様書へのリンクを追加し、索引から直接参照できるようにしました。

**テスト**
- 未実施(ドキュメントとコメントのみの変更のため)

必要に応じて `yarn storybook` で Docs.mdx の表示を確認してください。
This reverts commit bf853f8.
@quqjp quqjp force-pushed the vk/ff50-evaluationstar branch from 6ad67ca to a7e7b95 Compare December 5, 2025 02:47
@quqjp quqjp changed the base branch from feature/ai-work to main December 5, 2025 02:47
@quqjp quqjp changed the title WIP|EvaluationStar|Add EvaluationStar Specification EvaluationStar|Add EvaluationStar Specification Dec 5, 2025
@quqjp quqjp requested a review from Syunki0403 December 5, 2025 05:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants