Skip to content
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.

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

IMAGE: failing CI #87

Merged
merged 13 commits into from
Sep 16, 2024
Merged

IMAGE: failing CI #87

merged 13 commits into from
Sep 16, 2024

Conversation

kierisi
Copy link
Collaborator

@kierisi kierisi commented Aug 22, 2024

Added an image to the handbook showing what the red "X" looks like for a failing CI check. Resolves #82.

@@ -34,6 +34,9 @@ checks:
can be merged. The issues could be related to code style, formatting, tests,
or other criteria specified by the CI configuration.

![When a CI check fails, you'll see a red 'X' next to the CI check that hasn't passed](/images/ci-images/contributor-ci-fail.png)
Copy link
Member

Choose a reason for hiding this comment

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

@kierisi it's important that all of our documented are accessible. As such please add both an alt tag for accessibility and a caption. Here i think this is a caption, but it actually reads as an alt tag in the html rendered page.

You can either look at the myst markdown documentation for how to do this or look at how we add images in the packaging guide for guidance.

Copy link
Collaborator Author

@kierisi kierisi Aug 23, 2024

Choose a reason for hiding this comment

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

great catch! fixed.

Screenshot 2024-08-23 at 10 43 04 AM

@kierisi kierisi requested a review from lwasser August 23, 2024 15:47
kierisi added a commit to kierisi/handbook that referenced this pull request Aug 28, 2024
lwasser pushed a commit that referenced this pull request Aug 29, 2024
* Update README.md

clarified governance to be governance handbook, and corrected the link to point to the new handbook URL (was pointing to /governance)

* approve and run notification

* checked out CI image from #87

* updated image
@lwasser
Copy link
Member

lwasser commented Aug 29, 2024

There is a merge conflict on this pr now that I merged you with another pr #81 . Can you please fix @kierisi ?

@kierisi
Copy link
Collaborator Author

kierisi commented Sep 6, 2024

@lwasser should be fixed! thanks to @tracykteal and @rich-iannone for the assist on this one!

@lwasser lwasser merged commit 79a6eb7 into pyOpenSci:main Sep 16, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

IMAGE: add CI image (or GIF) showing failed CI
2 participants