Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update contribute docs with correct cli example #509

Merged
merged 3 commits into from
Jan 16, 2025
Merged

fix: update contribute docs with correct cli example #509

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1fbff6
fix: update contribute docs with correct cli example
itsarghyadas Jan 14, 2025
a35b650
fix: updated props table to the new standard
itsarghyadas Jan 15, 2025
39fdbe3
fix: lint fix and format command added in the docs
itsarghyadas Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
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
Loading