Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

49 lines (38 loc) · 1.73 KB
category page
Introduction
Contributing

Contributing to baseui

Getting started

  1. Clone the repo locally and run yarn to install dependencies from npm.
git clone [email protected]:uber/baseweb.git
cd baseui
yarn
  1. To start a website to develop against, run yarn documentation:dev.
  2. 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.

Definition of done

  • 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
  • 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.

Sending Pull Requests

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