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

Create a spreadsheet in the builds with rule information #2004

Closed
tombrunet opened this issue Aug 19, 2024 · 9 comments · Fixed by #2071
Closed

Create a spreadsheet in the builds with rule information #2004

tombrunet opened this issue Aug 19, 2024 · 9 comments · Fixed by #2071
Assignees
Labels
engine Issues in the accessibility-checker-engine component enhancement New feature or request

Comments

@tombrunet
Copy link
Member

Need columns for ruleid, group message, rule message, violation level, toolkit level, WCAG requirements

@tombrunet tombrunet self-assigned this Aug 19, 2024
@MHoov MHoov added enhancement New feature or request engine Issues in the accessibility-checker-engine component labels Aug 19, 2024
@philljenkins
Copy link
Contributor

The spreadsheet should have multiple lines in some cases to make it easier for sorting and comparing:

  • Some rules have multiple fail messages, so those rules should have multiple lines in the spreadsheet.
  • Some rules map to multiple WCAG SC's, so those rules should have multiple lines
  • Some rules map to ACT , so that column should be added.

@philljenkins
Copy link
Contributor

philljenkins commented Aug 20, 2024

@tombrunet See also the following spreadsheets for use cases & needs
ACT Master 2024.xlsx
Master-Checker-Rules-IBM-levels.xlsx
WCAG covered by Checker Rules Master.xlsx

@MHoov
Copy link

MHoov commented Aug 20, 2024

I have a call scheduled on Friday to discuss what we have in mind.

@MHoov
Copy link

MHoov commented Aug 20, 2024

@philljenkins lets discuss what this concept can cover before you start adding too many things please. This is intended to specifically address your comment last week about how difficult it was to review rules for consistency - and the files you provided to me in slack. This is not the larger concept in issue 6542 (Checker automated sync for rule to help requirements mapping)

@MHoov
Copy link

MHoov commented Oct 8, 2024

This what we discussed in the mural Consistency Map

Image

@philljenkins
Copy link
Contributor


The most granular level data item is the fail reason, if we have a row for each of them, then it should be easy to add the RuleID, Level, and even the ACT mapping.

An automatically created spreadsheet with these columns are what we need minimally:

  1. RuleID
  2. Group msg
  3. Fail msgs (there will be multiple rows, I suppose with RuleID and Group msg repeated)
  4. V, NR, Recommendation
  5. Level in Toolkit
  6. WCAG Requirement# (some rules map to more than one), ARIA, HTML
  7. *ACT ID (some rules/reason codes map to more than 1)
  8. Comments
  • not a column in the screenshot above

@philljenkins
Copy link
Contributor

Blocking #2030

@MHoov
Copy link

MHoov commented Oct 15, 2024

See related PR #2071

@philljenkins
Copy link
Contributor

@tombrunet also added "Pass" messages to spreadsheet.
and it's automatically generated during PR build process as an Artifact in Actions
Rule spreadsheet

I also recommend changing the file name
from: Rule spreadsheet
to: Rules mapping

@philljenkins philljenkins mentioned this issue Nov 5, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engine Issues in the accessibility-checker-engine component enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants