category	page
Introduction	Contributing

Contributing to baseui

Getting started

git clone git@github.com:uber/baseweb.git
cd baseweb
yarn

To start a website to develop against, run yarn documentation:dev.
To unit test your changes run yarn test or yarn 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.

While we are extremely grateful for all the contributions we get, sometimes we have to say no to some pull requests.

Usually, we reject contributions if they meet any of the following requirements:

Introduces a utility function/component, that's not used by Base Web itself.
New components that were not approved before sending the pull request. To make sure you don't run into any issues landing your new component to the library, please open a GitHub issue first to discuss the new addition.
Slight alterations of existing components - like introducing a new component called "Fancy Button".
Breaking changes - if your changeset introduces API changes, please make sure to do them in a backward-compatible way.
The PR includes opinionated changes that are not necessary - examples for this include introducing destructuring or moving files around based on personal preference.
Most examples for the documentation site that shows integration with a third-party library or service - we welcome these guides as blogposts. If you are interested in contributing one, please open a GitHub issue with the proposal!

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.

Commit messages should be formatted according to commitlint specifications. Doing so allows us to better document the baseweb changelog.

When send a pull request, please make sure that you have one of the following labels set: