Files

T

Robin Malfait 1affad1271 Simplify and improve overall structure (#1044 )

* simplify CI and make it consistent with CI of tailwindcss

* add contributing guidelines

* use correct org name

* ensure `yarn lint` is fully passing without warnings

* add subject to change message for `insiders` build

2022-01-17 15:46:18 +01:00

1.5 KiB

Raw Blame History

Contributing

Thanks for your interest in contributing to Headless UI! 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 components, exposing internal information, etc. Also make sure that you are making changes to both the React and Vue versions so that we can ensure feature parity.

Monorepo

The Headless UI repo is a monorepo using yarn workspaces. Note that we are using yarn version 1.

Coding standards

Our code formatting rules are defined by TSDX, which uses eslint and we also use prettier. You can check your code against these standards by running:

yarn lint

To automatically fix any style violations in your code, you can run:

yarn lint --fix

Running tests

You can run the test suite using the following commands:

yarn test

You can also run them for React of Vue individually:

yarn react test

# or

yarn vue test

Please ensure that the tests are passing when submitting a pull request. If you're adding new features to Headless UI, please include tests.

1.5 KiB Raw Blame History