From 4d6f70b55e0fc6122189b7508745038d399bab2e Mon Sep 17 00:00:00 2001 From: Xie Yanbo Date: Sat, 27 Dec 2025 14:30:58 +0800 Subject: [PATCH] docs: clarify versioning in README (#2177) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update the README.md to explicitly define MAJOR, MINOR, and PATCH increments for post-1.0.0 versioning, enhancing clarity and readability. ## Description > Should include a concise description of the changes (bug or feature), it's > impact, along with a summary of the solution ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) - [ ] Make sure to add `!` if this involve a breaking change 🛠️ Fixes # Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 172a1a6f12..13d08558d7 100644 --- a/README.md +++ b/README.md @@ -1035,12 +1035,12 @@ The version will be incremented as follows: ### Post-1.0.0 Versioning -Once the project reaches a stable `1.0.0` release, the versioning will follow -the more common convention: +Once the project reaches a stable `1.0.0` release, the version number +**`MAJOR.MINOR.PATCH`** will follow the more common convention: -- **`MAJOR.MINOR.PATCH`**: Incremented for incompatible API changes. -- **`MAJOR.MINOR.PATCH`**: Incremented for new, backward-compatible functionality. -- **`MAJOR.MINOR.PATCH`**: Incremented for backward-compatible bug fixes. +- **`MAJOR`**: Incremented for incompatible API changes. +- **`MINOR`**: Incremented for new, backward-compatible functionality. +- **`PATCH`**: Incremented for backward-compatible bug fixes. The public API that this applies to is the CLI associated with Toolbox, the interactions with official SDKs, and the definitions in the `tools.yaml` file.