Welcome UI - How to contribute

10.0.0

How to contribute

Workflow

Create your branch from main
Run yarn to setup the development environment.
Make the changes you want and test them out in the demo website before sending a pull request.
Add all necessary information and examples in your pull request.

We follow conventional commits convention ✨

The commit contains the following structural elements, to communicate intent to the consumers of your library:

We have a pre-commit hook to verify if your commit is correct 🚔

Each component will consist of:

You can report issues on our github project 🐛

Our documentation is based on NextJS with mdx files and nodejs script.

All component documentation is now located in its repository's docs folder:

index.mdx:
- Header: Contains the following information:
  - ariakit: Link (if used in this component, will be transformed into a button on the page header)
  - description: From ChatGPT
  - name
  - packageName: Name of the npm package
  - usage: If needed, for example, if the import is different from the component name
/examples:
- overview.mdx: The main example shown at the top of the component page
- Others: Your other examples
properties.json: Auto-generated with yarn watch. It includes the list of the component's properties.

Simply add your new page on it, it's magic!