2.0 KiB
Contributing
Thanks for your interest in contributing to Tailwind CSS! Please take a moment to review this document before submitting a pull request.
Pull requests
Please ask first before starting work on any significant new features.
It's never a fun experience to have your pull request declined after investing a lot of time and effort into a new feature. To avoid this from happening, we request that contributors create an issue to first discuss any significant new features. This includes things like adding new utilities, creating new at-rules, or adding new component examples to the documentation.
Coding standards
Our code formatting rules are defined in .eslintrc. You can check your code against these standards by running:
npm run style
To automatically fix any style violations in your code, you can run:
npm run style --fix
Running tests
You can run the test suite using the following commands:
npm test
Please ensure that the tests are passing when submitting a pull request. If you're adding new features to Tailwind, please include tests.
Building the documentation
Tailwind uses the Jigsaw static site generator for its documentation. Here is how you can generate the documentation locally:
-
Go to your Tailwind folder
cd tailwindcss -
Install JS dependencies
npm install -
Transpile the source code
npm run prepare -
Go to docs folder
cd docs -
Install PHP dependencies for docs (requires Composer: https://getcomposer.org)
composer install -
Install JS dependencies for docs
npm install -
Run the build to generate the static site
npm run dev -
View the static site at
/tailwind/docs/build_local, or you can run the Jigsaw server:./vendor/bin/jigsaw serve