itemit-web-common

Itemit UI Library and Common Helpers

This is a Next.js project bootstrapped with create-next-app.

Requirement

Node version - v16 and above. Make sure switching the node version to v16 (run nvm use within project)

Getting Started

First, install the dependency package:

npm install
# or
yarn 
# or
pnpm

then

npm run storybook
# or
yarn storybook
# or
pnpm storybook

You are ready to create components and test it in storybook!

Commit practise

1. With using semantic-release, our whole package release can be fully automated with their help, we just need to standardise the process on making a commit (not PR):

fix: [xxxx] - consider as Patch / Fix release
feat: [xxxx] - consder as Minor / Feature release
perf: [xxxx] + BREAKING CHANGE: [xxx] on footer - consider as Major / Breaking Release

2. Keep each commits small and easy to read if possible

Development

1. Create a branch from master - eg: feature/setup-tailwind-css
2. Make commits with following semantic-release standard.
3. Make and push changes in the branch
4. Once changes made and sufficient test is done, raise a PR in Github to beta.
5. Once PR is approved, proceed merge to beta.
6. New beta version will be release if follow commit practise, you can either inside PR / pipeline / repo's releases.
7. Install new beta package into your changes project.
8. QA tested completed, raise feature branch to master and follow the same step as 3 - 6.
9. If more fix or changes is required, follow the same step as 3 - 6 but to beta.
10. Remember to change your package version in your other repository branch before going to master.

Git Convention

Follow https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13