If you're reading this thank you for your interest in contributing to Frosted UI. Thank you for helping us make Frosted great! Here are a few guidelines to help contribute.
- Before opening a PR be sure to search exiting PRs or issues for an open or closed item that related to your submission.
We use semantic PR titles. Learn more about them here.
Example:
feat(button): Add right icon
We use ESLint and Prettier for formatting. We recommend installing both.
To lint all code you can run:
pnpm lint
When creating new components or updating existing component APIs be sure to update the storybook.
You can run the storybook locally by running pnpm --filter="frosted-ui" storybook
and then navigating to http://localhost:6006/