We appreciate your interest in contributing. This guide will help you get started with the contribution process.
We welcome all kinds of contributions:
- Feedback - have suggestions or ideas? Open a discussion to discuss it. Just note that this project is a port of shadcn/ui, meaning we won't be adding new components to this project unless they are added to
shadcn/uifirst. - Help & Support - if you enjoy helping others, join the Discord and help out in the
libs->shadcn-supportchannel, or answer questions asked in Discussions - Bug reports - please open an issue to report a bug.
- Docs fixes - spot a typo or broken link? Open a PR. If it's a larger change, please start a discussion first.
- Code improvements - For anything more involved than a quick fix, start a discussion first so we can align before you dive in.
We try to keep the process simple to avoid wasted effort:
- Open an issue for bugs
- Start a discussion for feature ideas, improvements, or questions
- A maintainer will review and tag it (e.g. help wanted, under review, etc.)
- Want to work on something? Just comment on the thread or open a PR.
Quick fix? For typos or small tweaks, feel free to skip the discussion and just open a PR. Bigger change? Open a discussion first so we can figure things out together.
If you're looking to contribute and have questions about the process or the codebase in general, feel free to ask in the Discord in the libs->shadcn-chat channel!
By contributing to this project, you agree that your contributions will be licensed under the LICENSE of the project.