Skip to content

UI Library for Design Engineers. Animated components and effects you can copy and paste into your apps. Free. Open Source.

fix: update contribute docs with correct cli example (#509)

Arghya Dasabfe8e589527
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f5930b08..2c00f883 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -123,7 +123,7 @@ published: true
<TabsContent value="cli">
```bash
-npx magicui-cli add example-component
+npx shadcn@latest add "https://magicui.design/r/example-component"
```
</TabsContent>
@@ -136,21 +136,17 @@ npx magicui-cli add example-component
<ComponentSource name="example-component" />
-<Step>Update the import paths to match your project setup.</Step>
-
</Steps>
</TabsContent>
</Tabs>
-<ComponentSource name="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
@@ -193,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