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

Update ruleset for consistency and ease-of-use #1

Open
ghost opened this issue Feb 27, 2023 · 4 comments · May be fixed by #2
Open

Update ruleset for consistency and ease-of-use #1

ghost opened this issue Feb 27, 2023 · 4 comments · May be fixed by #2
Labels
enhancement New feature or request

Comments

@ghost
Copy link

ghost commented Feb 27, 2023

I recommend making a few changes to the ruleset.xml file so that test runs are more consistent and easier to use/read:

  • Use colours for reports by default ('cause why not?)
  • Ignore .git directories
  • Remove comment about phpcbf (either the comment's not ture and we should remove it, or it is and we should remove the line it refers to as well)
  • Remove 'BETA' reference, since we're using this for all PRs in core now
@ghost ghost added the enhancement New feature or request label Feb 27, 2023
ghost pushed a commit that referenced this issue Feb 27, 2023
@ghost ghost linked a pull request Feb 27, 2023 that will close this issue
@indigoxela
Copy link
Collaborator

Hey, congratulation for opening issue #1 in this repo! 🎉

All fine with your PR (btw the comment about phpcbf is true, but I don't mind removing it).

Maybe some more feedback re colors turned on by default and removing beta state would be nice.

@ghost
Copy link
Author

ghost commented Feb 27, 2023

Well to me, 'beta' means something is still in development and isn't production-ready. And yet that's exactly what we're using this repo for - checking production code before it's committed. Yes we might still change/tweak/fix things as we go, but that's the same with Backdrop, etc. too.

The phpcbf comment says of the following line: "This cli arg is only relevant for phpcbf." The line is: <arg name="tab-width" value="2"/> If that is indeed true, and we're not actually using phpcbf (AFAIK), then should we remove that 'tab-width' argument line then?

As for using colour, here's an example without colour:
image

And here's one with colour:
image

So not a big difference, but I think it helps differentiate between errors and warnings, if nothing else.

@indigoxela
Copy link
Collaborator

Re colors: they only work fine with dark mode, otherwise text gets partly unreadable. That's why more feedback makes sense.

Beta or not? Not sure, yet. Honestly, I still think this ruleset is in an early stage of development. That doesn't necessarily mean, we can't declare it "stable". 😏

@yorkshire-pudding
Copy link
Contributor

I use dark mode regularly but still the contrast for red is never good for accessibility whatever the background:

  • 4:1 for white
  • 5.3:1 for black
  • 4.5:1 is pass rate for AA regular text (WCAG 2.1)
  • 7:1 is pass rate for AAA regular text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants