diff --git a/community/github/continuous-integration.md b/community/github/continuous-integration.md index 1aa6131..7170c06 100644 --- a/community/github/continuous-integration.md +++ b/community/github/continuous-integration.md @@ -34,6 +34,11 @@ checks: can be merged. The issues could be related to code style, formatting, tests, or other criteria specified by the CI configuration. +```{figure} /images/ci-images/contributor-ci-fail.png +:alt: A screenshot of the GitHub CI notifications for a sample pyOpenSci repository. There are four rows of information. The first row reads "1 workflow awaiting approval. This workflow requires approval from a maintainer. Learn more about approving workflows. 1 failing and 1 successful checks. To the far right of the row is linked text reading Hide all checks. The text Learn more about approving workflows is linked. The second row has a red x on the left, followed by the letter P in a gold square, and the text pre-commit.ci - pr -- checks completed with failures. To the far right is linked text reading Details. On the third row there is a green check mark followed by the Circle CI logo and the text ci/circleci: build_book -- Your tests passed on CircleCI! And to the far right there is linked text reading Details. The fourth and final row has a small white checkmark inside a large green circle with text reading This branch has no conflicts with the base branch. Only those with write access to this repository can merge pull requests. The text write access is linked. + +When a CI check fails, you'll see a red 'X' next to the CI check that hasn't passed +``` #### If a CI check is red 1. **Click on "Details"** next to the failed check to get more information