READMEのrefineとそれに伴う調整 - #113
Conversation
- プルリクエストテンプレートのビルドコマンドを `pnpm build` から `pnpm build:package` に変更 - READMEにおけるコンポーネントライブラリの説明をNext.jsからReact.jsに修正 - 特徴セクションを追加し、柔軟性、アクセシビリティ、カスタマイズ性について記述
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR refines the README to make it more user-friendly and accessible, with improved structure and visual elements. The changes transform a developer-focused document into a more polished project presentation with enhanced usability.
- Added visual thumbnail and reorganized content structure for better readability
- Simplified installation and usage instructions with clearer sections
- Updated CI workflow and PR template to align with current project structure
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Complete restructure with visual header, streamlined content, and improved organization of installation/usage guides |
| .github/workflows/ci.yml | Added push trigger for main branch and fixed quote consistency |
| .github/pull_request_template.md | Updated build command reference from generic build to specific build:package |
| ``` | ||
|
|
||
| または、グローバルにインストールした場合： | ||
| React.js + TypeScript を用いたコンポーネントライブラリです。<br /> |
There was a problem hiding this comment.
Using HTML <br /> tags in Markdown is not a best practice. Consider using two spaces at the end of the line or a blank line for line breaks in Markdown.
| React.js + TypeScript を用いたコンポーネントライブラリです。<br /> | |
| React.js + TypeScript を用いたコンポーネントライブラリです。 |
|
|
||
| ### 個別コンポーネントの導入 | ||
|
|
||
| Sparkle Design は shadcn/ui registry に対応しています。レジストリの URL は Storybook からコピーすることができます。<br /> |
There was a problem hiding this comment.
Using HTML <br /> tags in Markdown is not a best practice. Consider using two spaces at the end of the line or a blank line for line breaks in Markdown.
| Sparkle Design は shadcn/ui registry に対応しています。レジストリの URL は Storybook からコピーすることができます。<br /> | |
| Sparkle Design は shadcn/ui registry に対応しています。レジストリの URL は Storybook からコピーすることができます。 |
|
|
||
| ```tsx | ||
| import { ButtonProps } from "sparkle-design"; | ||
| 以下のコマンドで `sparkle.config.json` の設定に基づいて、デザインシステムに準拠した CSS を生成します。<br /> |
There was a problem hiding this comment.
Using HTML <br /> tags in Markdown is not a best practice. Consider using two spaces at the end of the line or a blank line for line breaks in Markdown.
| 以下のコマンドで `sparkle.config.json` の設定に基づいて、デザインシステムに準拠した CSS を生成します。<br /> | |
| 以下のコマンドで `sparkle.config.json` の設定に基づいて、デザインシステムに準拠した CSS を生成します。 |
- CIバッジのリンクを正しいURLに更新しました。
There was a problem hiding this comment.
サムネイル用意する場合は全体に確認を取ったり必要に応じてデザイナーをアサインしたいです！！
There was a problem hiding this comment.
あ、これは仮画像という扱いのつもりでした！
最終の画像はもちろんデザイナーアサインしたいです🙆
概要
READMEを再編集し、より使いやすい形に修正しました
変更内容
動作確認
pnpm lintを実行pnpm build:packageを実行してプロジェクトが正常にビルドされることを確認pnpm testを実行してテストがすべて成功することを確認関連 Issue