category | page |
---|---|
Introduction |
Contributing |
- Clone the repo locally and run
yarn
to install dependencies from npm.
git clone [email protected]:uber/baseweb.git
cd baseui
yarn
- To start a website to develop against, run
yarn documentation:dev
. - To unit test your changes run
yarn test
oryarn test --watch
to continuously run the relevant tests.
Do you miss a component? Would you like to extend the featureset of a component? This document helps you navigate the process.
- Each component has a drop-in, stateful, stateless, styled (presentation) components exported
- When you add examples for the documentation site, try to prioritize stateless examples with hooks
- Browser accessibility support and aria attributes
- A11y rules can be found here,
- Run
yarn lint
, which has eslint-plugin-jsx-a11y running as part of it https://github.com/evcohen/eslint-plugin-jsx-a11y#supported-rules, - Check out
TESTING.md
to learn how to run end-to-end tests
- Styletron for CSS-in-JS styling
- Unit tests with jest and enzyme
- Flow type coverage for all relevant component code and tests
- TypeScript coverage for the API
- Documentation added to the docs site. You start the doc site using
yarn documentation:dev:watch
.
When send a pull request, please make sure that you have one of the following labels set:
- breaking
- feature
- bugfix
- docs
- discussion
- release
- prerelease
- greenkeeping