From 6f2097d98f5fae62b39c57c0ffb4a98d267fc6de Mon Sep 17 00:00:00 2001
From: Rohan Mehta <rm@openai.com>
Date: Wed, 4 Jun 2025 15:27:27 -0400
Subject: [PATCH 1/2] Add release documentation

---
 docs/release.md | 24 ++++++++++++++++++++++++
 mkdocs.yml      |  1 +
 2 files changed, 25 insertions(+)
 create mode 100644 docs/release.md

diff --git a/docs/release.md b/docs/release.md
new file mode 100644
index 000000000..0e18da81f
--- /dev/null
+++ b/docs/release.md
@@ -0,0 +1,24 @@
+# Release process
+
+The project follows semantic versioning using the form `0.Y.Z`. The leading `0` indicates the SDK is still evolving rapidly. Increment the components as follows:
+
+## Minor (`Y`) versions
+
+Increase `Y` for **breaking changes** to any public interfaces that are not marked as beta.
+
+## Patch (`Z`) versions
+
+Increment `Z` for:
+
+- Bug fixes
+- New features
+- Changes to private interfaces
+- Updates to beta features
+
+## Steps to cut a release
+
+1. Ensure `main` is stable and all tests pass.
+2. Update the version in `pyproject.toml`.
+3. Document notable changes in `CHANGELOG.md`.
+4. Tag the commit with the version number and push the tag.
+5. Publish the release on GitHub and PyPI.
diff --git a/mkdocs.yml b/mkdocs.yml
index a58258a93..b79e6454f 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -72,6 +72,7 @@ plugins:
                     - models/litellm.md
                 - config.md
                 - visualization.md
+                - release.md
                 - Voice agents:
                     - voice/quickstart.md
                     - voice/pipeline.md

From 0377a054bf622939982025cf46f1564e6dd2f7d5 Mon Sep 17 00:00:00 2001
From: Rohan Mehta <rm@openai.com>
Date: Wed, 4 Jun 2025 15:29:24 -0400
Subject: [PATCH 2/2] Update release.md

---
 docs/release.md | 16 +++++-----------
 1 file changed, 5 insertions(+), 11 deletions(-)

diff --git a/docs/release.md b/docs/release.md
index 0e18da81f..3bfc6e9b8 100644
--- a/docs/release.md
+++ b/docs/release.md
@@ -1,24 +1,18 @@
 # Release process
 
-The project follows semantic versioning using the form `0.Y.Z`. The leading `0` indicates the SDK is still evolving rapidly. Increment the components as follows:
+The project follows a slightly modified version of semantic versioning using the form `0.Y.Z`. The leading `0` indicates the SDK is still evolving rapidly. Increment the components as follows:
 
 ## Minor (`Y`) versions
 
-Increase `Y` for **breaking changes** to any public interfaces that are not marked as beta.
+We will increase minor versions `Y` for **breaking changes** to any public interfaces that are not marked as beta. For example, going from `0.0.x` to `0.1.x` might include breaking changes.
+
+If you don't want breaking changes, we recommend pinning to `0.0.x` versions in your project.
 
 ## Patch (`Z`) versions
 
-Increment `Z` for:
+We will increment `Z` for non-breaking changes:
 
 - Bug fixes
 - New features
 - Changes to private interfaces
 - Updates to beta features
-
-## Steps to cut a release
-
-1. Ensure `main` is stable and all tests pass.
-2. Update the version in `pyproject.toml`.
-3. Document notable changes in `CHANGELOG.md`.
-4. Tag the commit with the version number and push the tag.
-5. Publish the release on GitHub and PyPI.