@mxenabled/mxui 1.0.2 → 1.0.3-alpha.JB0

package/README.md

@@ -7,20 +7,16 @@ In order to run the project you will need to make sure that you have yarn instal
 
 ## Contributing
 
-If your MR includes any changes outside of documentation, you will need to incrememnt the version correctly and publish that new version.
+If your MR includes any changes outside of documentation, you will need to ensure the following:
 
-1. Ensure you update the CHANGELOG.md as part of your MR
-1. Update the version in the package.json file as part of your MR
+1. Update the `CHANGELOG.md` as part of your MR.
+1. Do not update the version in the `package.json` file, as it will be handled automatically by `shipit`.
 
 ## Merging and Publishing
+To merge and publish, comment `shipit --publish-version=major/minor/patch` once the MR is approved.  
+Shipit will handle version bumping based on the specified flag (major, minor, or patch), publish the package to the npm registry, merge the MR into the master branch, and create a corresponding tag.
 
-Pre-requisites to publishing: you'll need to get an ower to add you to the "mxenabled" organization in npm. If you do not have an npm account already, create one with your mx email at https://www.npmjs.com/, then send a message to Bill Bridegroom on Slack to get added to the org. Once this is done, you'll need to run `npm adduser` in your terminal to authenticate.
-
-1. After your MR is approved, type `shipit` in the comments. Wait for shipit to merge your branch (it will comment on your MR when it has finished doing its thing.)
-1. After your changes have been merged to master, switch to the master branch and pull down the new changes.
-1. Run `npm publish --dry-run`.
-1. If the dry run works, go ahead and run `npm publish`. Look for something like '@mxenabled/mxui@1.4.2' in the terminal output. Copy it and paste it to the end of `git tag` ex: `git tag @kyper/mui@2.4.2`in the terminal. After that, run `git push origin --tags` and you're done.
-
+> **Note:** If an alpha version is to be published, update the package version to include a pre-release identifier like `1.2.3-alpha.1` or `1.2.3-v1` and run the `publish:nodejs-npmregistry` job to publish that alpha version.
 
 ## Using this Library