Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

82 lines (53 loc) · 1.68 KB
Raw

Contributing

Thanks for your interest in contributing to react-tailwindcss-select! 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.

Installation

You only require a yarn install in the root directory to install everything you need.

yarn install

Coding standards

We use prettier for making sure that the codebase is formatted consistently. To automatically fix any style violations in your code, you can run:

Using yarn

yarn pret:fix

Using npm

npm pret:fix

Running playground

We currently use next.js as server for live testing.

You can run the dev script and open your browser to http://localhost:8888.

See complete props usage in pages/index.js file.

Using yarn

yarn dev

Using npm

npm dev

Before you make a Pull Request

We recommend to run these scripts in sequence before you make your commit message amd open a Pull Request

Let's clean the code first

yarn pret:fix

Test a build of your changes

yarn build