Merge branch 'main' of github.com:manufac-analytics/perry into sumitn…

…egi7/#8-vapor-pressure-batch10

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    "recommendations": [
+        "vivaxy.vscode-conventional-commits",
+        "axetroy.vscode-changelog-generator",
+        "natqe.reload"
+    ]
+}

README.md

@@ -79,7 +79,7 @@ Per Palmer Group guidelines, [always use named exports.](https://github.com/palm
 
 ## Publishing to NPM
 
-We recommend using [np](https://github.com/sindresorhus/np).
+Run `yarn version`. Maintainers with publishing rights alone shall be able to publish to NPM.
 
 ## Branching Workflows
 
@@ -93,4 +93,12 @@ We recommend using [np](https://github.com/sindresorhus/np).
 
 We follow the [Git Feature Branch Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow) for pushing new features into the `master` branch.
 
+## Commits Format
+
+- We use the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification to decide how to format our commit messages.
+- This is not strictly enforced at the moment but the developers are expected to follow this specification while commiting important changes like bringing in a new feature, making a breaking change to the API, or any change that the developer feels should be reflected in the CHANGELOG in the subsequent release.
+- Conventional commits integrate well with the [SemVer](https://semver.org/) versioning pattern and this compatibility is the main reason for its adoption.
+- Conventional commits also play well with [`yarn version`](https://classic.yarnpkg.com/en/docs/cli/version/) giving us the power to automate the releases and the corresponding CHANGELOG generation.
+- The [Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits) extension makes the formating & compliance of the commit messages a cake-walk!
+
 ---

package.json

@@ -1,12 +1,44 @@
 {
-  "version": "0.1.0",
+  "name": "@manufac-analytics/perry",
+  "author": "maneetgoyal",
+  "version": "0.1.0-alpha.6",
+  "description": "Process Design Utilities",
+  "keywords": [
+    "Cheminformatics",
+    "Chemical Engineering",
+    "Chemistry",
+    "NodeJS",
+    "TypeScript"
+  ],
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
+  "module": "dist/perry.esm.js",
+  "size-limit": [
+    {
+      "path": "dist/perry.cjs.production.min.js",
+      "limit": "100 KB"
+    },
+    {
+      "path": "dist/perry.esm.js",
+      "limit": "100 KB"
+    }
+  ],
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/manufac-analytics/perry.git"
+  },
+  "bugs": {
+    "url": "https://github.com/manufac-analytics/perry/issues"
+  },
+  "homepage": "https://github.com/manufac-analytics/perry#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
   "engines": {
     "node": ">=14"
   },
@@ -17,27 +49,16 @@
     "lint": "tsdx lint --fix",
     "prepare": "tsdx build && husky install",
     "size": "size-limit",
-    "analyze": "size-limit --why"
+    "analyze": "size-limit --why",
+    "preversion": "yarn build && yarn test",
+    "postversion": "git push origin v$npm_package_version && git push && yarn publish --new-version $npm_package_version"
   },
   "prettier": {
     "printWidth": 80,
     "semi": true,
     "singleQuote": true,
     "trailingComma": "es5"
   },
-  "name": "@manufac-analytics/perry",
-  "author": "maneetgoyal",
-  "module": "dist/perry.esm.js",
-  "size-limit": [
-    {
-      "path": "dist/perry.cjs.production.min.js",
-      "limit": "100 KB"
-    },
-    {
-      "path": "dist/perry.esm.js",
-      "limit": "100 KB"
-    }
-  ],
   "devDependencies": {
     "@size-limit/preset-small-lib": "^4.11.0",
     "husky": "^6.0.0",