reactive-bulma 1.4.0 → 1.6.0

package/README.md

@@ -1,4 +1,4 @@
-# Reactive bulma ![Reactive bulma version](https://img.shields.io/github/package-json/v/nicolasomar/reactive-bulma?color=success&label=%20&style=flat-square)
+# Reactive bulma ![reactive-bulma version](https://img.shields.io/github/package-json/v/nicolasomar/reactive-bulma?label=npm&logo=npm&labelColor=535353&color=success&style=flat-square) ![reactive-bulma Coverage](https://img.shields.io/codecov/c/github/nicolasomar/reactive-bulma?label=coverage&labelColor=535353&logo=codecov&style=flat-square) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=NicolasOmar_reactive-bulma&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=NicolasOmar_reactive-bulma) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=NicolasOmar_reactive-bulma&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=NicolasOmar_reactive-bulma) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=NicolasOmar_reactive-bulma&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=NicolasOmar_reactive-bulma)
 Component library based on React, typescript and bulma
 
 ## What do I need?
@@ -14,19 +14,38 @@ npm install
 ```
 
 ## How to run it
-To run it's storybook (until `v1.1.0`, it will have an example button only)
+To initiate on `Storybook mode` (see alternatives and interact with any component)
 ```sh
 npm start
 ```
-To rebuild the project with your changes
+To compile the project with your changes
 ```sh
 npm run build
 ```
 
+## Folder structure
+Once you have cloned the repo, it will show you the following folders:
+- `.github:` [Github Actions](https://github.com/features/actions/) files used to run post-merge.commits like unit test coverage collection.
+- `.husky:` Dedicated to [Husky](https://typicode.github.io/husky/) git-hook files.
+- `.storybook:` Dedicated to [Storybook](https://storybook.js.org/) configuration.
+- `src:`
+  - `components:` Location of all used components, using [Atomic Design hierarchy structure](https://atomicdesign.bradfrost.com/chapter-2/) (`atoms` -> `molecules` -> `organisms`).
+
+## Versioning
+After intestigating [semantic-release documentation](https://semantic-release.gitbook.io/semantic-release/) (reffer to [#3](https://github.com/NicolasOmar/reactive-bulma/issues/3)) and having a problematic implementation, I decided to change version meaning for this project with the following:
+- Major versions (`1.0.0`, `2.0.0` and beyond) will reffer to milestones/version achievement.
+- Minor versions (`1.1.0`, `1.2.0` and so on) will reffer to branch/story completition.
+- Patch versions (`1.0.1`, `1.0.2` and so on) will reffer to bugfixes only.
+
+To know more about actual roadmap, please go to section `Find out more` -> `Roadmap`.
+
+## Branches and Environments
+I will maintain only one deployable site based on [Storybook](https://storybook.js.org/) with automated [Netlify](https://netlify.com/) deployments with each push to `main` branch. The mentioned site is on section `Find out more` -> `Storybook site`.
+
 ## Find out more
-| [Project Status](https://github.com/users/NicolasOmar/projects/3) | [Storybook site](https://my-pets-storybook.netlify.app/) | [Npm Package](https://www.npmjs.com/package/reactive-bulma)
-| :--- | :--- | :--- |
-| Project board for project status tracking | Site dedicated to show and test all the created components | Public package site in npm
+| [Roadmap](https://docs.google.com/document/d/1kWX-dDTD-cQUeB_Vbu0K6xRvtHaSA38h76yQnhiCe9U) | [Project Status](https://github.com/users/NicolasOmar/projects/3) | [Storybook site](https://my-pets-storybook.netlify.app/) | [Npm Package](https://www.npmjs.com/package/reactive-bulma)
+| :--- | :--- | :--- | :--- |
+| Document with entire list of stories, splitted by versions | Project board for project status tracking | Site dedicated to show and test all the created components | Public package site in npm
 
 ## License
 **MIT**

package/dist/cjs/index.js

@@ -2840,7 +2840,15 @@ function requireReact_development () {
 
 var React = /*@__PURE__*/getDefaultExportFromCjs(reactExports);
 
-const Button = ({ text = '' }) => (React.createElement("button", { className: 'button' }, text));
+const Button = ({ text = '' }) => (React.createElement("button", { "data-testid": 'test-button', className: 'button' }, text));
+
+const Column = ({ size = null, offset = null, isNarrow = false, children = null }) => {
+    const classes = ['column', size, offset, isNarrow ? 'is-narrow' : null]
+        .filter(_class => _class)
+        .join(' ');
+    return (React.createElement("section", { "data-testid": 'test-column', className: classes }, children));
+};
 
 exports.Button = Button;
+exports.Column = Column;
 //# sourceMappingURL=index.js.map