From cf648d4a07870e36a877af810fa20c9526df6b77 Mon Sep 17 00:00:00 2001 From: wenjiefan Date: Mon, 13 Jul 2026 11:08:00 +0200 Subject: [PATCH] Document BCQuality versioning in README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index ddab523..c49ccd0 100644 --- a/README.md +++ b/README.md @@ -136,6 +136,21 @@ For the end-to-end flow — from orchestrator trigger through to how output reac │ └── /skills/ ``` +## Versioning + +BCQuality content is released on demand — roughly monthly, not on every commit. A +release is a `major.minor` value in [`VERSION`](VERSION), cut manually via the +`Release version` workflow, which tags the current `main` as `v{VERSION}`. + +- Bump the **minor** for the usual periodic content update; bump the **major** + only for a breaking change. +- The minor is a **monotonic counter** — it only ever increments and never + resets, even across a major bump — so it uniquely identifies a release. + +The PRReviewAgent orchestrator ([microsoft/BC-ALAgents](https://github.com/microsoft/BC-ALAgents)) +pins a BCQuality release and composes it into its own `X.Y.Z` version, where +**Z** is this release's minor. See that repo for the full cross-repo scheme. + ## Contributing Contributions are welcome. Before submitting a PR: