How to Contribute - Flowbite Svelte
Learn how you can start contributing to the open-source Flowbite Svelte UI component library
Here are some guidelines we’d like you to follow before submitting a PR.
Create a fork #
Create a fork from flowbite-svelte to your repository first.
Please use pnpm to install #
The repo uses pnpm
, so using pnpm
is desirable when you fork and install dependencies to avoid unseen problems.
When there is a change in package.json
, remove pnpm-lock.yml
and node_modules
directory and run pnpm i
.
Tailwind CSS #
Tailwind warns that you don’t construct class names dynamically. Instead of this:
<div class="text-{{ error ? 'red' : 'green' }}-600"></div>
Always use complete class names:
<div class="{{ error ? 'text-red-600' : 'text-green-600' }}"></div>
Types and Props #
Please run the following to update prop files.
pnpm svelte-helpers
This command is to generate component documentation for all Svelte files within the src/lib directory and generate JSON files containing props information from all Svelte files in the src/lib directory, placing them in the routes/component-data directory.
Format and check #
Please run the following to format the code.
pnpm format && pnpm check
Conventional commit #
When making a commit, we recommend using the Conventional commits.
Some examples are:
feat: add rating component
fix: add if statement to Button component
chore: clean up About page
docs: add timeline page
style: update home page
test: add modal test
Use !
for a minor bump.
feat!: add drawer component and page
When you have a breaking change:
git commit -a "feat: change btnClass name to bClass" -m "BREAKING CHANGE: change the Button component attributes"
Playwright Test #
Before submitting a PR, please run a test:
pnpm test:e2e
If you want to run an single test file, tests/typography.spec.ts
:
npx playwright test tests/typography.spec.ts
A11y Test #
We recommend to test a page with Nu Html Checker relating to your change.
Test a page.
axe http://localhost:3000/dropdowns/image