Merge pull request #92 from celo-org/soloseng/update-release-md

Updated release md
celo-org · Oct 16, 2023 · 03a8b9f · 03a8b9f
2 parents 0cea652 + b237310
commit 03a8b9f
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/.changeset/twelve-fireants-mix.md b/.changeset/twelve-fireants-mix.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/RELEASE.md b/RELEASE.md
@@ -38,3 +38,15 @@ yarn changeset publish --no-git-tag --snapshot
 
 ```
 <https://github.com/changesets/changesets/blob/main/docs/snapshot-releases.md>
+
+
+## Package Versioning
+
+Based on semantic versioning best practices [semver.org](semver.org)
+
+Given a version number MAJOR.MINOR.PATCH, increment the:
+- MAJOR version when you make incompatible API changes
+- MINOR version when you add functionality in a backward compatible manner
+- PATCH version when you make backward compatible bug fixes
+
+Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
diff --git a/package.json b/package.json
@@ -80,4 +80,4 @@
     "@types/bn.js": "4.11.6",
     "bignumber.js": "9.0.0"
   }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -80,4 +80,4 @@ @@
         "@types/bn.js": "4.11.6",
         "bignumber.js": "9.0.0"
       }
-    }
+    }