From 5eb9fec21c427213083360292de6ce5a4f270d80 Mon Sep 17 00:00:00 2001 From: jamesgeorge007 <25279263+jamesgeorge007@users.noreply.github.com> Date: Fri, 26 Sep 2025 14:19:08 +0530 Subject: [PATCH] docs: document CLI versioning scheme --- packages/hoppscotch-cli/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/hoppscotch-cli/README.md b/packages/hoppscotch-cli/README.md index aa9f0ec0..ac7c32b3 100644 --- a/packages/hoppscotch-cli/README.md +++ b/packages/hoppscotch-cli/README.md @@ -88,6 +88,16 @@ hopp [options or commands] arguments - Opt out from the experimental scripting sandbox. +## Versioning + +The Hoppscotch CLI follows **pre-1.0 semantic versioning** conventions while in alpha (version `< 1.0.0`): + +- **Feature releases** (e.g., `0.20.0` → `0.21.0`): New features, enhancements, or improvements +- **Patch releases** (e.g., `0.20.0` → `0.20.1`): Bug fixes, security patches, and minor improvements +- **Breaking changes** (e.g., `0.21.0` → `0.30.0`): Major version-like bumps for backwards-incompatible changes + +> Once the CLI reaches stability and a mature feature set, we will transition to standard semantic versioning starting with `1.0.0`. + ## Install - Before you install Hoppscotch CLI you need to make sure you have the dependencies it requires to run.