From 28e949692340e61fed5b9b44baaefb1d95061b1a Mon Sep 17 00:00:00 2001 From: Jim Garrison Date: Wed, 4 Sep 2024 10:49:32 -0400 Subject: [PATCH] Update deprecation policy (#667) * Updated deprecation policy * drop "do our best to" * Update `index.rst` --- README.md | 2 +- docs/index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d3597f80c..86de7246a 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ For information on installing from source, running CKT in a container, and platf ### Deprecation Policy -This project is meant to evolve rapidly and, as such, does not follow [Qiskit's deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md). We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the [release notes](https://qiskit-extensions.github.io/circuit-knitting-toolbox/release-notes.html). +We follow [semantic versioning](https://semver.org/) and are guided by the principles in [Qiskit's deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md). We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the [release notes](https://qiskit-extensions.github.io/circuit-knitting-toolbox/release-notes.html). ---------------------------------------------------------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 246ddc35b..d8022f570 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,7 @@ The toolbox currently contains the following tools: For a more detailed discussion on circuit cutting, check out our `technical guide <./circuit_cutting/explanation/index.rst#overview-of-circuit-cutting>`__. -This project is meant to evolve rapidly and, as such, does not follow `Qiskit's deprecation policy `__. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the :ref:`release notes`. +We follow `semantic versioning `__ and are guided by the principles in `Qiskit's deprecation policy `__. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the :ref:`release notes`. Citing this project -------------------