SubmittingPatches: clarify GitHub visual
GitHub has two general forms for its states, sometimes they're a simple colored object (e.g. green check or red x), and sometimes there's also a colored container (e.g. green box or red circle) which contains that object (e.g. check or x). That's a lot of words to try to describe things, but in general, the key for a failure is that it's recognized as an `x` and that it's associated with the color red -- the color of course is problematic for people who are red-green color-blind, but that's why they are paired with distinct shapes. Signed-off-by: Josh Soref <jsoref@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Josh Soref committed
Dec 28, 2023 at 04:55 UTC
0771a3b55ca137f32567635c1a96222892bd7499
1 file changed
+5
-5
Documentation/SubmittingPatches
+5
-5
@@ -602,11 +602,11 @@ After the initial setup, CI will run whenever you push new changes
602
to your fork of Git on GitHub. You can monitor the test state of all your
603
branches here: `https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml`
604
605
-If a branch did not pass all test cases then it is marked with a red
606
-cross. In that case you can click on the failing job and navigate to
607
-"ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You
608
-can also download "Artifacts" which are tarred (or zipped) archives
609
-with test data relevant for debugging.
605
+If a branch does not pass all test cases then it will be marked with a
606
+red +x+, instead of a green check. In that case, you can click on the
607
+failing job and navigate to "ci/run-build-and-tests.sh" and/or
608
+"ci/print-test-failures.sh". You can also download "Artifacts" which
609
+are tarred (or zipped) archives with test data relevant for debugging.
610
611
Then fix the problem and push your fix to your GitHub fork. This will
612
trigger a new CI build to ensure all tests pass.