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 to rules format 1.1 #2220

Merged
merged 5 commits into from
Nov 21, 2024
Merged

Update to rules format 1.1 #2220

merged 5 commits into from
Nov 21, 2024

Conversation

WilcoFiers
Copy link
Member

@WilcoFiers WilcoFiers commented Oct 24, 2024

  • Move assumptions & accessibility support section to the background
  • Add a rules_format property to the page front matter
  • Update the outcome definition
  • Update the tests
  • Update the templates

Need for Call for Review: 2 weeks, this is a substantial change


How to Review And Approve

  • Go to the “Files changed” tab
  • Here you will have the option to leave comments on different lines.
  • Once the review is completed, find the “Review changes” button in the top right, select “Approve” (if you are really confident in the rule) or "Request changes" and click “Submit review”.
  • Make sure to also review the proposed Call for Review period. In case of disagreement, the longer period wins.

Copy link
Member

@carlosapaduarte carlosapaduarte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The preamble of the rule-design document (pages/design/rule-design.md) still had a mention of the rule format 1.0. I've updated it with this commit

Copy link
Collaborator

@dan-tripp-siteimprove dan-tripp-siteimprove left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found some references to rules format 1.0 in some examples, in the files _rules/html-page-lang-matches-default-ucwvc8.md , _rules/image-no-text-0va7u6.md , and pages/examples/element-language.md. Not sure if you care about that.

Copy link
Collaborator

@HelenBurge HelenBurge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@WilcoFiers WilcoFiers added the Review call 2 weeks Call for review for new rules and big changes label Nov 4, 2024

- [rule name here](./abc123)

### Bibliography
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "Bibliography" under Background should be "Other Resources".

pages/glossary/outcome.md Show resolved Hide resolved
- **Failed:** A [test target](https://www.w3.org/TR/act-rules-format/#test-target) does not meet all expectations
- **Passed:** A [test target][] meets all expectations
- **Failed:** A [test target][] does not meet all expectations
- **cantTell:** Whether the rule is applicable, or not all expectations were met could not be fully determined by the tester.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **cantTell:** Whether the rule is applicable, or not all expectations were met could not be fully determined by the tester.
- **cantTell:** Whether the rule is applicable, or whether all expectations were met could not be fully determined by the tester.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should make this change in the rules format first.

- **Passed:** A [test target][] meets all expectations
- **Failed:** A [test target][] does not meet all expectations
- **cantTell:** Whether the rule is applicable, or not all expectations were met could not be fully determined by the tester.
- **Untested**: The tester has not attempted to evaluate the test subject.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Untested**: The tester has not attempted to evaluate the test subject.
- **Untested**: The test subject was not evaluated for the rule.

@WilcoFiers WilcoFiers merged commit 5ba46d9 into develop Nov 21, 2024
2 checks passed
@WilcoFiers WilcoFiers deleted the background-refactor branch November 21, 2024 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Review call 2 weeks Call for review for new rules and big changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants