es-components

Exchange Solutions React components

Documentation and Demos

https://twexchangesolutions.github.io/es-components/

Versioning

Use semantic versioning to ensure that a consistent version is always available for publish. Use npm version in order to increase the version numbers. Push version updates as a separate commit.

Major

Consider a major version update when any of the following is true:

• a dependency is updated to the next major version
• a new dependency is added that requires major infrastructure changes (build tools, testing tools, etc.)

Minor

Consider a minor version update when any of the following is true:

• a new component is added to the package exports
• a new feature is added to an existing component
• build tooling is updated or fixed

Patch

Consider a patch version update when any of the following is true:

• a bug fix is made to an existing component

Publishing

Publishing to npm

Consider publishing to npm when any of the following is true

• a new component is added to the package exports

Publishing Documentation

Any time the npm package is published, the documentation should be updated as well. Execute npm run styleguide-build to generate a new version of the docs. Push documentation build as a seperate commit.

Contributing

When adding a component, refer to the Exchange Solutions UI Guidelines. This is a work-in-progress, so communicate with the UX team if you have any questions.

Submit a pull request when you're ready to have your code reviewed and apply the ready for review label. Once it has been reviewed, ensure the version and documentation commits have been added and apply the ready for merge label.

See CONTRIBUTING.md for more information on standards.

Tools

Components are built using React and styled-components. Tests are written using Jest with Enzyme for rendering.

The component guide is built using react-styleguidist.

Project Structure

- src
| - components
  | - base
    | - icons
      | - Icon.js
      | - Icon.md
      | - Icon.specs.js

Build commands

npm run build (build javascript)
npm run styleguide-server (run the styleguide on localhost:6060)