daywon-ui-storybook

Instructions for Raising a Pull Request (PR)

When you create a story for any component, please adhere to the following steps:

1. Default Exports:

   • Ensure that all components have default exports.

2. Update src/index.ts:

   • Add your component to the src/index.ts file and export it as shown below:

     export { default as Checkbox } from './components/Checkboxes/Checkbox';

3. Don't forget to run build:

   • Open a terminal and run:

   yarn build

   • This ensures that the code adheres to coding standards and does not introduce any breaking changes.

Instructions for Publishing Components to the daywon-storybook Library on npm

Publishing Permissions

• Only the manager of the master branch is authorized to publish to npm, as it requires npm account credentials.

Steps to Publish

After merging your code into the main branch, follow these steps:

1. Log in to npm:

   • Open a terminal and run:

     npm login

   • Enter your npm username and password when prompted.

2. Update the Package Version:

   • Run the following command to update the version of your npm package:

     npm version <major | minor | patch>

   • For example, if your current version is ^1.0.2, 1 is the major version, 0 is the minor version, and 2 is the patch version.

3. Publish the Package:

   • Finally, publish the package by running:

     npm publish

Confirmation

If everything works correctly, your package will be published to npm with the new version.

You generally only need to run these commands to publish:

npm login
npm version patch
npm publish

Reverting Published Versions:

npm unpublish --force

• Be cautious with this, as npm only allows unpublishing within 72 hours of publishing, and it should be used sparingly.