@retirable/component-library

This package represents Retirable's component library npm package. Download instructions:

yarn add @retirable/component-library

Contributing:

If interested in contributing, please email [email protected].

File structure rules:

• Components are consolidated into folders with similar components - for example all buttons live within the buttons folder.
• The styles associated with a particular component are defined in the same file that the component is defined within.
• If a style is used in all the components within a particular folder, but does not itself have its own component, that style is defined within a styles folder and the file is named base[CategoryOfComponent]Styles.

Versioning:

Our component library uses semantic versioning conventions. The following provides a summary of this pattern.

[MAJOR].[MINOR].[PATCH]

• The major version should be updated when a change breaks services that currently use the library. As an example, if a required prop is added to an existing component, updating to the latest version of the package will cause the existing components to break.
• Minor versions should be updated when additional functionality, albeit non-breaking, is introduced. As an example, if a new variant is added to a component, the minor version should be updated.
• Patch versions should be updated when backwards-compatible bugs are fixed.

Additional resources:

• https://semver.org/
• https://docs.npmjs.com/about-semantic-versioning