@kepler-io/core-react
v1.0.47
Published
This project represents the Kepler React library.
Keywords
Readme
Kepler Lib - React
This project represents the Kepler React library.
Build
Run yarn build.
Installation
Kepler Node Lib is installable as NMP Module: npm install @kepler-io/core-react.
Upgrade of package is available via command: npm upgrade @kepler-io/core-react
Packing
You can test packaging locally via npm pack and observe generated tar file.
Publishing
Publishing is done via NPM (not Yarn): npm run publish-remote.
https://www.npmjs.com/search?q=kepler-io
Versioning
In order for your publish to be successfull you must increment the version on the package.json file following the instructions below:
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards compatible manner, and
- PATCH version when you make backwards compatible bug fixes.
You can test your local features using a pre-release version, following the rules below:
- A pre-release version MAY be denoted by appending a hyphen and a series of dot separated identifiers immediately following the patch version.
- Identifiers MUST comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-].
- Identifiers MUST NOT be empty. Numeric identifiers MUST NOT include leading zeroes.
- Pre-release versions have a lower precedence than the associated normal version.
- A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version.
Examples: 1.0.0-alpha, 1.0.0-alpha.1, 1.0.0-0.3.7, 1.0.0-x.7.z.92, 1.0.0-x-y-z.–.
Styling
To contribute to styling, there are a couple of rules to follow:
- We use stylelint to enforce style rules. Please install IDE extension to make sure you get instant linter feedback
- Go through all defined variables in files in
stylesfolder, and use them in your code. - We strive to have our design as flexible as possible, therefore we design in pixels, and code in rems. To take advantage of this, use
premfunction available in the_sizes.scss"` file. - Our styles are component-based, using CSS Modules. We're enforcing camelCase class names. We don't use BEM.