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

Provide rationale for the rules enabled or disabled #21

Open
khiga8 opened this issue Dec 22, 2022 · 2 comments
Open

Provide rationale for the rules enabled or disabled #21

khiga8 opened this issue Dec 22, 2022 · 2 comments
Assignees

Comments

@khiga8
Copy link
Contributor

khiga8 commented Dec 22, 2022

I think it will be helpful to provide context on why we recommend these configurations.

In base.json

{
    "default": true,
    "no-inline-html": false,
    "no-bare-urls": false,
    "no-blanks-blockquote": false,
    "fenced-code-language": true
}

In accessibility.json

{
    "no-alt-text": true,
    "no-default-alt-text": true,
    "no-duplicate-header": true,
    "no-emphasis-as-header": true,
    "no-generic-link-text": true,
    "no-space-in-links": false,
    "ol-prefix": "ordered",
    "single-h1": true,
    "ul-style": true
}

Some of these are somewhat obvious, while others are less so.

@chris-c-thomas
Copy link

I think a doc page of some sort would definitely be great. I love opinionated things but also want to know the reasoning behind other's choices before I adopt it.

@andrialexandrou
Copy link
Collaborator

Adding a note here to emphasize how some of the accessibility rules here are indeed related to accessibility, for instance

  • ul style asterisk
  • no space in links being disabled
  • ol prefix ordered

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

No branches or pull requests

3 participants