Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 883 Bytes

README.md

File metadata and controls

42 lines (28 loc) · 883 Bytes
Raw

Plural's design system

Documentation

Installation

npm i -S @pluralsh/design-system

Usage

Import { Alert } from '@pluralsh/design-system'

// ...
return (
  <Alert
    severy="success"
    title="Wouhou!"
  >
    You installed @pluralsh/design-system correcly
  </Alert>
)

Development

npm i && npm start and view the Storybook at http://localhost:6006

Checklist for creating a new component:

  • Does it have proper type definitions?
  • Does it have prop types?
  • Can it pass a ref with forwardRef?
  • Does it have a story in the Storybook?

Contributing

We use semantic pr conventions for all prs, if you want a commit to be present in a release, be sure to prefix its commit message with either feat: or fix:. Use fix!: or feat!: for breaking changes to trigger a major version release.

License

MIT