Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.39 KB

README.md

File metadata and controls

64 lines (45 loc) · 2.39 KB
Raw

NPM Version codecov DeepSource

@kubevirt-ui/components

alt gopher network

React Component Library for Kubevirt UI (API reference)

Add to your project

yarn add -D @kubevirt-ui/components

Contributing

When contributing code, use the development server, and check for linting documentation and testing.

Run linter

yarn lint # or yarn lint:fix to fix trivial linting errors

Run tests

yarn test

Run develpment server (http://localhost:6060):

yarn styleguide

Run develpment server with cluster proxy (http://localhost:9090):

yarn styleguide:proxy

Build the static documentation:

yarn styleguide:build

When should I contribute my components to this repository?

When a componenet used by an application is stable it can be published in this components repository so public users could:

  • Use the components for exiting new applications
  • Study how the component works
  • Redistribute the component as they are
  • Modified and create better components based on the components in this repository

How to document my component when contributing to this repository?

Before moving a component to this repo make sure the code is documented with descriptions and examples in a markdown doc as needed to help users who are not familiar with the application and context understand what is the purpose of the component and how to use it.

Scope

Kubevirt UI compoents is a curated list of stable and documented components used by Kubevirt UI aplications and libraries. Kuevirt UI is based on PatternFly and Openshift console, it extend them to create specilized components needed for Kubevirt design.