From 9cf59c4971d60abfcdc8660a2d828824b2e0bae6 Mon Sep 17 00:00:00 2001 From: Tobias Nyholm Date: Sat, 16 Jul 2016 18:37:52 +0200 Subject: [PATCH 1/7] Added a note about BC --- httplug/backwards-compatibility.rst | 28 ++++++++++++++++++++++++++++ index.rst | 2 ++ 2 files changed, 30 insertions(+) create mode 100644 httplug/backwards-compatibility.rst diff --git a/httplug/backwards-compatibility.rst b/httplug/backwards-compatibility.rst new file mode 100644 index 0000000..e8a61df --- /dev/null +++ b/httplug/backwards-compatibility.rst @@ -0,0 +1,28 @@ +Backwards compatibility +======================= + +Backwards compatibility is an important topic for us, as it should be in every open source project. We follow +[Semver](http://semver.org/) which allows us to only break backwards compatibility between major versions. We use +deprecation notices to inform you about the changes made before they are removed. + +Our backwards compatibility promise does not include classes or functions with the ``@internal`` annotation. + +Symfony Bundle +-------------- + +The HttplugBundle is just a Symfony integration for HTTPlug and it does not have any classes which falls under the BC +promise. The backwards compatibility of the bundle is only the configuration and its values (and of course the behavior +of those values). + +Discovery +--------- + +The order of which the strategies are included is not part of our BC promise. The strategies them self is marked +with ``@internal`` so they are also not part of our BC promise. +However, we do promise that we will not remove a strategy neither will we remove classes from the ` +``CommonClassesStrategy``. We will also support the following Puli versions: +* 1.0.0-beta10 + +The consequences of the BC promise on the discovery library is that you can never be sure *what* client that is +being returned but you can be sure that if discovery finds you a client we will not make an update that will break +discovery for you. diff --git a/index.rst b/index.rst index d7b23d0..b3e8d4f 100644 --- a/index.rst +++ b/index.rst @@ -74,6 +74,8 @@ for discussion around a future HTTP client PSR. integrations/index + Backwards compatibility + .. toctree:: :hidden: :caption: Components From 16b9064b8a58ed6ebf6cab9f2b30786d90d57c72 Mon Sep 17 00:00:00 2001 From: Tobias Nyholm Date: Sat, 16 Jul 2016 18:58:59 +0200 Subject: [PATCH 2/7] syntax error --- httplug/backwards-compatibility.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/httplug/backwards-compatibility.rst b/httplug/backwards-compatibility.rst index e8a61df..29155eb 100644 --- a/httplug/backwards-compatibility.rst +++ b/httplug/backwards-compatibility.rst @@ -2,7 +2,7 @@ Backwards compatibility ======================= Backwards compatibility is an important topic for us, as it should be in every open source project. We follow -[Semver](http://semver.org/) which allows us to only break backwards compatibility between major versions. We use +Semver_ which allows us to only break backwards compatibility between major versions. We use deprecation notices to inform you about the changes made before they are removed. Our backwards compatibility promise does not include classes or functions with the ``@internal`` annotation. @@ -26,3 +26,5 @@ However, we do promise that we will not remove a strategy neither will we remove The consequences of the BC promise on the discovery library is that you can never be sure *what* client that is being returned but you can be sure that if discovery finds you a client we will not make an update that will break discovery for you. + +.. _Semver: http://semver.org/ \ No newline at end of file From da5dd0d47ea00584138b2c70b667389d770c67fb Mon Sep 17 00:00:00 2001 From: Tobias Nyholm Date: Sat, 16 Jul 2016 23:47:41 +0200 Subject: [PATCH 3/7] Typo --- httplug/backwards-compatibility.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/httplug/backwards-compatibility.rst b/httplug/backwards-compatibility.rst index 29155eb..271d8a3 100644 --- a/httplug/backwards-compatibility.rst +++ b/httplug/backwards-compatibility.rst @@ -17,8 +17,8 @@ of those values). Discovery --------- -The order of which the strategies are included is not part of our BC promise. The strategies them self is marked -with ``@internal`` so they are also not part of our BC promise. +The order of which the strategies are included is not part of our BC promise. The strategies themselves are marked +as ``@internal`` so they are also not part of our BC promise. However, we do promise that we will not remove a strategy neither will we remove classes from the ` ``CommonClassesStrategy``. We will also support the following Puli versions: * 1.0.0-beta10 @@ -27,4 +27,4 @@ The consequences of the BC promise on the discovery library is that you can neve being returned but you can be sure that if discovery finds you a client we will not make an update that will break discovery for you. -.. _Semver: http://semver.org/ \ No newline at end of file +.. _Semver: http://semver.org/ From b57689a8abe6a2dbec6f16ac5e8bbc00410d37d5 Mon Sep 17 00:00:00 2001 From: Tobias Nyholm Date: Mon, 18 Jul 2016 08:26:34 +0200 Subject: [PATCH 4/7] typo --- httplug/backwards-compatibility.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/httplug/backwards-compatibility.rst b/httplug/backwards-compatibility.rst index 271d8a3..db03402 100644 --- a/httplug/backwards-compatibility.rst +++ b/httplug/backwards-compatibility.rst @@ -17,7 +17,7 @@ of those values). Discovery --------- -The order of which the strategies are included is not part of our BC promise. The strategies themselves are marked +The order of the strategies is not part of our BC promise. The strategies themselves are marked as ``@internal`` so they are also not part of our BC promise. However, we do promise that we will not remove a strategy neither will we remove classes from the ` ``CommonClassesStrategy``. We will also support the following Puli versions: From b3dbf8b0e87874f4361cdef8bb422e0867306508 Mon Sep 17 00:00:00 2001 From: Tobias Nyholm Date: Mon, 18 Jul 2016 08:27:59 +0200 Subject: [PATCH 5/7] Better wording --- httplug/backwards-compatibility.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/httplug/backwards-compatibility.rst b/httplug/backwards-compatibility.rst index db03402..e6835e2 100644 --- a/httplug/backwards-compatibility.rst +++ b/httplug/backwards-compatibility.rst @@ -23,8 +23,8 @@ However, we do promise that we will not remove a strategy neither will we remove ``CommonClassesStrategy``. We will also support the following Puli versions: * 1.0.0-beta10 -The consequences of the BC promise on the discovery library is that you can never be sure *what* client that is -being returned but you can be sure that if discovery finds you a client we will not make an update that will break -discovery for you. +The consequences of the BC promise for the discovery library is that you can not rely on the *same* client to be +returned in the future. However, you can be sure that if discovery finds you a client now, future updates will still +find a client. .. _Semver: http://semver.org/ From 2041fea833a6f32d816a3eb2946e5d8dc5220fbe Mon Sep 17 00:00:00 2001 From: Tobias Nyholm Date: Mon, 18 Jul 2016 08:35:11 +0200 Subject: [PATCH 6/7] Removed backtick and added one more supported Puli version --- httplug/backwards-compatibility.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/httplug/backwards-compatibility.rst b/httplug/backwards-compatibility.rst index e6835e2..b698d3f 100644 --- a/httplug/backwards-compatibility.rst +++ b/httplug/backwards-compatibility.rst @@ -19,8 +19,9 @@ Discovery The order of the strategies is not part of our BC promise. The strategies themselves are marked as ``@internal`` so they are also not part of our BC promise. -However, we do promise that we will not remove a strategy neither will we remove classes from the ` +However, we do promise that we will not remove a strategy neither will we remove classes from the ``CommonClassesStrategy``. We will also support the following Puli versions: +* 1.0.0-beta9 * 1.0.0-beta10 The consequences of the BC promise for the discovery library is that you can not rely on the *same* client to be From 0d08cf4d6677702d52b9e1b23907fc5f6231e913 Mon Sep 17 00:00:00 2001 From: Tobias Nyholm Date: Mon, 18 Jul 2016 09:25:42 +0200 Subject: [PATCH 7/7] Using Christians suggestion --- httplug/backwards-compatibility.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/httplug/backwards-compatibility.rst b/httplug/backwards-compatibility.rst index b698d3f..34a5d15 100644 --- a/httplug/backwards-compatibility.rst +++ b/httplug/backwards-compatibility.rst @@ -25,7 +25,6 @@ However, we do promise that we will not remove a strategy neither will we remove * 1.0.0-beta10 The consequences of the BC promise for the discovery library is that you can not rely on the *same* client to be -returned in the future. However, you can be sure that if discovery finds you a client now, future updates will still -find a client. +returned in the future. However, if discovery does find a client now, you can be sure that after future updates it will still discover a client. .. _Semver: http://semver.org/