From d1fbff6234606fb22733b8871d367c67de9efd80 Mon Sep 17 00:00:00 2001 From: Arghya Das Date: Tue, 14 Jan 2025 16:47:14 +0530 Subject: [PATCH 1/3] fix: update contribute docs with correct cli example --- CONTRIBUTING.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5930b08a..cbbef4a88 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -123,7 +123,7 @@ published: true ```bash -npx magicui-cli add example-component +npx shadcn@latest add "https://magicui.design/r/example-component" ``` @@ -136,16 +136,12 @@ npx magicui-cli add example-component -Update the import paths to match your project setup. - - - ## Props | Prop | Type | Description | Default | From a35b650293d28cb74db3468736ec674a0b2a5b90 Mon Sep 17 00:00:00 2001 From: Arghya Das Date: Wed, 15 Jan 2025 18:24:51 +0530 Subject: [PATCH 2/3] fix: updated props table to the new standard --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cbbef4a88..a952ddd0c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -144,9 +144,9 @@ npx shadcn@latest add "https://magicui.design/r/example-component" ## Props -| Prop | Type | Description | Default | -| ----- | ------ | -------------------------- | ------- | -| color | String | The color of the component | "blue" | +| Prop | Type | Default | Description | +| ------- | -------- | -------- | -------------------------- | +| `color` | `String` | `"blue"` | The color of the component | ```` ### 5. Update Registry From 39fdbe3e68b620aed1248a3d99488191806171fb Mon Sep 17 00:00:00 2001 From: Arghya Das Date: Thu, 16 Jan 2025 10:26:27 +0530 Subject: [PATCH 3/3] fix: lint fix and format command added in the docs --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a952ddd0c..2c00f8833 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -189,6 +189,18 @@ Make sure to add any necessary dependencies, tailwind configurations, or other p pnpm build:registry ``` +### 7. Format and fix linting before committing + +```bash +pnpm format:write +``` + +```bash +pnpm lint:fix +``` + +Make sure to run these two commands before committing your changes. + ## Adding to the showcase ### 1. Create your showcase as a MDX file