Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improve docs on automated tests #17040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2020
Merged

Improve docs on automated tests #17040

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 30 additions & 9 deletions doc/devel/coding_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,24 +161,45 @@ Merging
A core dev should only champion one PR at a time and we should try to keep
the flow of championed PRs reasonable.

* Do not self merge, except for 'small' patches to un-break the CI or
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've moved this section to the Merging section to here because it covers mergin not automated tests.

when another reviewer explicitly allows it (ex, "Approve modulo CI
passing, may self merge when green").

.. _pr-automated-tests:

Automated tests
---------------

* Make sure the Travis, Appveyor, CircleCI, and codecov tests are passing
before merging.
Whenever a pull request is created or updated, various automated test tools
will run on all supported platforms and versions of Python.

* Make sure the Travis, Appveyor, CircleCI, and Azure pipelines are passing
before merging (All checks are listed at the bottom of the GitHub page of
your pull request). Here are some tips for finding the cause of the test
failure:

- If *Travis flake8* fails, you have a code style issue, which will be listed
near the bottom of the *Travis flake8* log.
- If any other Travis run fails, search the log for ``FAILURES``. The
subsequent section will contain information on the failed tests.
- If CircleCI fails, likely you have some reStructuredText style issue in
the docs. Search the CircleCI log for ``WARNING``.
- If Azure pipelines fail with an image comparison error, you can find the
images as *artifacts* of the Azure job:

- Whenever a pull request is created or updated, Travis and Appveyor
automatically runs the test suite on all versions of Python
supported by Matplotlib. The tox_ support in Matplotlib may be
useful for testing locally.
- Click *Details* on the check on the GitHub PR page.
- Click *View more details on Azure Pipelines* to go to Azure.
- On the overview page *artifacts* are listed in the section *Related*.


* Codecov and LGTM are currently for information only. Their failure is not
necessarily a blocker.

* tox_ is not used in the automated testing. It is supported for testing
locally.

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

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

.. _pr-squashing:

Expand Down