This patch set follows through on discussion related to fast
tracking changes in Tempest that are required to unblock other
project gates. So, the "When to approve" section of the REVIEWING
documentation has been expanded to include a fast track
provision: that 1 core reviwer can +2 a change and approve it,
provided that the core reviwer belonging to the project with
the failing gate +1's the change, too.
Change-Id: Iafb9de650cd79b3c72b03e20690dd80a95308b5b
This patch set corrects some misleading documentation under "Unit
Tests" section in REVIEWING.rst.
It currently claims that service clients do not require unit test
coverage -- but this is false. This is because Tempest now places
all of its service clients in tempest.lib. And as per
https://docs.openstack.org/tempest/latest/library.html#testing it
is required to add unit tests for all service client interfaces.
Thus this makes the documentation language clear that service clients
require unit tests.
Change-Id: Iac6ba71496e20b6724a6a2ca4ec2beb42f2a58c8
This patch set adds information on test removal, relocation,
renaming to REVIEWING because it is important that such
actions do not break interop. Interop is closely tied to
Tempest because it directly references Tempest tests that
are not only expected to exist, but to also work.
The same is true of breaking blacklist/whitelist
references to Tempest tests, this is also included
in the new documentation section.
It is important that there be REVIEWING guidelines
in place to assist reviewers understand this importance.
Also references are included for defcore/interop to help
users find more information on these topics.
Currently interop is only mentioned in 1 place in Tempest [0]
and yet there is little information about it. This patchset
aims to make it easier to find more information about it
for reviewers and users alike.
[0] http://git.openstack.org/cgit/openstack/tempest/tree/doc/source/test_removal.rst
Change-Id: Ifbde674b42355077fcd8daa07be8be1248b77b0f
Reviewing the REVIEWING.rst of tempest,
I noticed a plural mistake.
The word "APIs" is plural and it shouldn't add 'a' in the front.
And there is an extra "that" before "which".
So I fix it.
Change-Id: I84d81f44314feadaebfcd4a834f854364328593b
This commit fixes indentation in tempest docs. These indentations are
not necessary and it causes a weird html outputs.
Change-Id: I9c8714558a3327b7ad0b0ab0d3fdc7e770c3c75b
Most of them can still be visited through http, but the following
one is necessary to update, so I change them all by this chance.
$ git clone http://git.openstack.org/openstack/tempest
Change-Id: I2b4da0670b599666e7151bddfff0fa6655640bc4
I've been reading our entire documentation to see where it could
be improved. It's guide good actually. While reading I've fixed
some typos, added some capitalization to project names, mostly
trivial stuff.
What's worth reviewing is the 2 paragraphs I added to the REVIEWING
guidelines.
Change-Id: I977de335119f4ff7b9aedcfbed31c264ed531ea8
This commit adds a deprecated code review guideline. We have some
deprecated code (e.g. stress test) now. And we sometimes wonder whether
we should review a patch for deprecated code or not. So this patch tries
to clear up the situation.
Change-Id: I188cd9fccae9396b143fa85071387e8a5bb5f3d1
This commit adds a brief section about ensuring release notes are
present to the reviewing doc. This should hopefully make it more
clear to reviewers when we need to include release notes.
Change-Id: I0815b9c24f6ec9e384b1657c94ed387d0d748392
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 fixes a few things in the tempest docs. First it fixes all
of the sphinx warnings and enables fail on warn to ensure we're using
valid sphinx everywhere. It also adds a link from the configuration
guide to the sample config file.
Change-Id: I3ad645a6bbfa46b4498e1732410743e46d6eb0cb
This commit adds a new section the HACKING and REVIEWING docs. It
explains the guidelines around inline documentation when
contributing new tests.
Change-Id: Ib56723d0c748baf41439975102d1363f81085f50