[v2,7/9] SubmittingPatches: clarify GitHub visual

Commit Message

Josh Soref Dec. 21, 2023, 4:41 p.m. UTC

From: Josh Soref <[e-mail]>

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) with containing 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.

Using the term `cross` doesn't really help.

Signed-off-by: Josh Soref <[e-mail]>
---
 Documentation/SubmittingPatches | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Junio C Hamano Dec. 21, 2023, 9:27 p.m. UTC | #1

"Josh Soref via GitGitGadget" <[e-mail]> writes:

> From: Josh Soref <[e-mail]>
>
> 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) with containing 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.
>
> Using the term `cross` doesn't really help.

I am not sure if this is accurate.  Using `x` alone does not help,
either.

I think this was raised during the review of the initial round, but
...

>  If a branch did not pass all test cases then it is marked with a red
> -cross. In that case you can click on the failing job and navigate to
> ++x+. In that case you can click on the failing job and navigate to

... it would help if we added something like ", instead of a green
checkmark" after "with a red x".  It will make the contrast with the
succeeding case stronger.  IOW, we can take advantage of the idea to
use "pair with distinct shapes and colors" ourselves.

>  "ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You
>  can also download "Artifacts" which are tarred (or zipped) archives
>  with test data relevant for debugging.

Patch

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 4476b52a50f..8f79253c5cb 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -603,7 +603,7 @@  to your fork of Git on GitHub.  You can monitor the test state of all your
 branches here: `https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml`
 
 If a branch did not pass all test cases then it is marked with a red
-cross. In that case you can click on the failing job and navigate to
++x+. In that case you can click on the failing job and navigate to
 "ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You
 can also download "Artifacts" which are tarred (or zipped) archives
 with test data relevant for debugging.