From 3eb7a892d95c9511c254a16e36b47c6ed1330c91 Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Thu, 5 Jun 2014 15:40:33 -0400 Subject: [PATCH] Add README section about API stability This commit adds a section to the README outlining that tempest tests should only be added for stable APIs. If the API is tested the expectation is that it complies with the API stability guidelines. Change-Id: I02a93f66ff45e4d687b7395fb24ee5bda6e52fb0 --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.rst b/README.rst index 0e933ccaba..ea36619b65 100644 --- a/README.rst +++ b/README.rst @@ -176,3 +176,11 @@ If a test is being added for a feature that exists in all the current releases of the projects then the only concern is that the API behavior is the same across all the versions of the project being tested. If the behavior is not consistent the test will not be able to merge. + +API Stability +------------- + +For new tests being added to Tempest the assumption is that the API being +tested is considered stable and adheres to the OpenStack API stability +guidelines. If an API is still considered experimental or in development then +it should not be tested by Tempest until it is considered stable.