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.

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

Conversation

itsarghyadas
Copy link
Collaborator

Before
image

After
image

Another suggestion is to include the pnpm format:write and pnpm lint:fix commands in the documentation, so that when everyone is making a PR, it is already formatted and linted correctly.

Copy link

vercel bot commented Jan 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
magicui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 16, 2025 4:58am

Copy link
Collaborator

@dillionverma dillionverma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small changes then lgtm

CONTRIBUTING.md Outdated
</Steps>

</TabsContent>

</Tabs>

<ComponentSource name="example-component" />

## Props

| Prop | Type | Description | Default |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might as well update the props as well to match the latest format

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Will update the PR

Copy link
Collaborator

@dillionverma dillionverma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🔥

@itsarghyadas itsarghyadas merged commit abfe8e5 into main Jan 16, 2025
5 checks passed
@itsarghyadas itsarghyadas deleted the contribute-docs-improvement branch January 16, 2025 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants