- 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.
For explicit component authoring and consumption guidance, see components-workflow.mdx.
We follow conventional commits convention ✨
The commit contains the following structural elements, to communicate intent to the consumers of your library:
- fix: patches a bug in your codebase
- feat: introduces a new feature to the codebase
- BREAKING CHANGE: introduces a breaking API change
- refactor: introduce code refactor
- docs: changes into documentation
- test: adding or updating tests
- chore: tooling changes, chore changes
We have a pre-commit hook to verify if your commit is correct 🚔
You can report issues on our github project 🐛
Use components-workflow.mdx as the canonical guide for:
- writing or updating components inside WUI,
- consuming components outside WUI,
- required tests and docs,
- local validation before opening a pull request.
- You are building or changing component code in this repository: follow Inside WUI.
- You are integrating the published package in another repository: follow Outside WUI.
Our documentation is based on Next.js + MDX.
For foundation pages, add a new MDX file in website/build-app/pages/foundations.