Skip to content

Commit cb856ba

Browse files
committed
Improve docs on automated tests
1 parent 065769b commit cb856ba

1 file changed

Lines changed: 21 additions & 9 deletions

File tree

doc/devel/coding_guide.rst

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -161,24 +161,36 @@ Merging
161161
A core dev should only champion one PR at a time and we should try to keep
162162
the flow of championed PRs reasonable.
163163

164+
* Do not self merge, except for 'small' patches to un-break the CI or
165+
when another reviewer explicitly allows it (ex, "Approve modulo CI
166+
passing, may self merge when green").
167+
164168
.. _pr-automated-tests:
165169

166170
Automated tests
167171
---------------
168172

169-
* Make sure the Travis, Appveyor, CircleCI, and codecov tests are passing
170-
before merging.
173+
Whenever a pull request is created or updated, various automated test tools
174+
will run on all supported platforms and versions of Python.
175+
176+
* Make sure the Travis, Appveyor, CircleCI, and Azure pipelines are passing
177+
before merging. Here are some tips for finding the cause of the test failure:
171178

172-
- Whenever a pull request is created or updated, Travis and Appveyor
173-
automatically runs the test suite on all versions of Python
174-
supported by Matplotlib. The tox_ support in Matplotlib may be
175-
useful for testing locally.
179+
- If *Travis flake8* fails, you have a code style issue, which will be listed
180+
near the bottom of the *Travis flake8* log.
181+
- If any other Travis run fails, search the log for ``FAILURES``. The
182+
subsequent section will contain information on the failed tests.
183+
- If CircleCI fails, likely you have some reStructuredText style issue in
184+
the docs. Search the CircleCI log for ``WARNING``.
185+
186+
* Codecov and LGTM are currently for information only. Their failure is not
187+
necessarily a blocker.
188+
189+
* tox_ is not used in the automated testing. It is supported for testing
190+
locally.
176191

177192
.. _tox: https://tox.readthedocs.io/
178193

179-
* Do not self merge, except for 'small' patches to un-break the CI or
180-
when another reviewer explicitly allows it (ex, "Approve modulo CI
181-
passing, may self merge when green").
182194

183195
.. _pr-squashing:
184196

0 commit comments

Comments
 (0)