Add docs section on config options to reviewers guide

This commit adds an additional section to the reviewers guide to
elaborate on the policy around configuration options. We already
documented part of it in the plugin interface documentation, but this
should make the policy around it a bit more clear.

Change-Id: Ied2d7b3298d613b7e986b31fd0a08ad7c73afa3b
This commit is contained in:
Matthew Treinish 2015-09-08 10:39:58 -04:00
parent daca419af5
commit 13a1ed668a
No known key found for this signature in database
GPG Key ID: FD12A0F214C9E177
1 changed files with 13 additions and 0 deletions

View File

@ -51,6 +51,19 @@ skipped or not. Do not approve changes that depend on an API call to determine
whether to skip or not.
Configuration Options
With the introduction of the tempest external test plugin interface we needed
to provide a stable contract for tempest's configuration options. This means
we can no longer simply remove a configuration option when it's no longer used.
Patches proposed that remove options without a deprecation cycle should not
be approved. Similarly when changing default values with configuration we need
to similarly be careful that we don't break existing functionality. Also, when
adding options, just as before, we need to weigh the benefit of adding an
additional option against the complexity and maintenance overhead having it
Test Documentation
When a new test is being added refer to the :ref:`TestDocumentation` section in