Skip to content

Commit

Permalink
fix: update contribute docs with correct cli example (#509)
Browse files Browse the repository at this point in the history
* fix: update contribute docs with correct cli example

* fix: updated props table to the new standard

* fix: lint fix and format command added in the docs
  • Loading branch information
itsarghyadas authored Jan 16, 2025
1 parent 3859af2 commit abfe8e5
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit abfe8e5

Please sign in to comment.