Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.6 KB

README.md

File metadata and controls

72 lines (45 loc) · 2.6 KB
Raw

Kopano REACT UI component library

Kpop is a collection of React UI components and UI uitilites for Kopano Web apps. All components are located in the src directory.

Using kpop as dependency

Kpop should be added from a release tarball with a fixed version.

yarn add https://download.kopano.io/community/kapp:/kpop-${KPOP_RELEASE}.tgz

Versioning scheme

Kpop uses a simple major.minor.patch versioning scheme, which only guarantees backwards compatibility on patch level changes until we reach version 1.0.0. For this reason, it is essential that consumers of kpop pin the version number.

  • Major increases on all changes affecting multiple components and/or other fundamental changes. On Major increase, all other digits are set to zero.

  • Minor increases when a new component or utility function was added. Once kpop reaches version 1.0.0, minor increases are also backwards compatible. When minor increases, the patch digit is set to zero,

  • Patch increases whenever something changes which does not change any functionality. It includes only fixes for defects.

Development

Adding a new component

Adding components to kpop should follow the following simple guidelines.

  1. Implement the component as a local component in your app and make the component feature complete.

  2. Verify that the component works without the rest of the app and then check that the component is useful for other apps.

  3. Check passed, so make a branch of kpop, and copy of the component to an appropriate folder inside the src tree of kpop.

  4. Create a kpop branch of your app, where you remove the local component and let the app instead import the component from kpop.

  5. App works, so create a pull request to kpop master branch with your component. Use one commit per new component and do not mix up.

  6. Eventually the component gets merged into kpop master and released. Then update your kpop app branch with the correct dependency of the kpop release which contains the new component and create a pull request for your app.

Minimal requirements for components in kpop

  1. Create a new directory in src with the name of your component: mkdir src/Example.

  2. Create the new component src/Example/Example.js

  3. Create an index.js file which exports the newly created component.

  4. Create a test file src/Example/Example.spec.js, this should only contain unit tests to be run with jest.

  5. Create a readme file src/Example/README.md and add a simple demo of the new component. More information about documenting components can be found here.