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.

Sign up for GitHub

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

Jump to bottom

chore: Update templates to CR format #488

Merged
merged 7 commits into from May 27, 2019
Merged

chore: Update templates to CR format #488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0a9772f
chore: Update templates to CR format
WilcoFiers Apr 24, 2019
819bfa2
Update atomic-template-empty.md
WilcoFiers May 7, 2019
6639ed2
Update to composite rule template
WilcoFiers May 7, 2019
7b00bc7
Update rule-template.md
WilcoFiers May 7, 2019
680a7c4
udpate
jeeyyy May 15, 2019
3be9e8f
Merge branch 'develop' into cr-template
jeeyyy May 18, 2019
cc6a436
Merge branch 'develop' into cr-template
jeeyyy May 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 30 additions & 15 deletions pages/design/atomic-template-empty.md
View file
Open in desktop
@@ -1,35 +1,50 @@
---
id:
name:
rule_type: atomic

description: |
This rule checks ...

success_criterion:
- x.x.x # (Name of Success Criterion)

test_aspects:
accessibility_requirements: # Remove whatever is not applicable
wcag20:x.x.x: # <Name of Success Criterion> (A | AA | AAA)
forConformance: true | false
failed: not satisfied
passed: satisfied | further testing needed
inapplicable: satisfied | further testing needed

aria11:x.x.x: # <Heading in WAI-ARIA>
forConformance: true | false
failed: not satisfied
passed: satisfied | further testing needed
inapplicable: satisfied | further testing needed

wcag-technique:x.x.x: # <Technique title>
forConformance: true | false
failed: not satisfied
passed: satisfied | further testing needed
inapplicable: satisfied | further testing needed

jeeyyy marked this conversation as resolved.
Show resolved Hide resolved
input_aspects:
- # (e.g. HTTP Messages, DOM Tree, CSS Styling, Accessibility Tree, Language, etc.,)

authors:
- # (full names as found in `contributors` property in `package.json` - if not yet listed, please have authors added to the list)
---

## Test Procedure

### Applicability
## Applicability

The rule applies to any (??) element ...
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we make it "This rule applies to..." since this is the wording we mostly use.
And should it be a comment instead, since this is not always the wording used?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I would still like to see this changed, if I am to approve this PR.

Copy link
Collaborator

Choose a reason for hiding this comment

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

The is a definite article in English grammar used when the author/ reader knows exactly what is being referred to.

Eg:
It is the newest building in the town.
Who is the president of Madagascar?

Given we are in the context of the rule. I believe the is the right usage over this.


### Expectation (1)
## Expectation (1)
jeeyyy marked this conversation as resolved.
Show resolved Hide resolved

Each target element ...
jeeyyy marked this conversation as resolved.
Show resolved Hide resolved

## Assumptions

_There are currently no assumptions_

## Accessibility support
## Accessibility Support

_There are no major accessibility support issues known for this rule._

Expand All @@ -41,42 +56,42 @@ _There are no major accessibility support issues known for this rule._

### Passed

#### Passed example 1
#### Passed Example 1

Description...
jeeyyy marked this conversation as resolved.
Show resolved Hide resolved

```html
<!-- code -->
```

#### Passed example 2
#### Passed Example 2

...

### Failed

#### Failed example 1
#### Failed Example 1

Description...
jeeyyy marked this conversation as resolved.
Show resolved Hide resolved

```html
<!-- code -->
```

#### Failed example 2
#### Failed Example 2

...

### Inapplicable

#### Inapplicable example 1
#### Inapplicable Example 1

Description...
Copy link
Collaborator

Choose a reason for hiding this comment

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

Again: Should this be a comment?


```html
<!-- code -->
```

#### Inapplicable example 2
#### Inapplicable Example 2

...
51 changes: 33 additions & 18 deletions pages/design/composite-template-empty.md
View file
Open in desktop
@@ -1,37 +1,52 @@
---
id:
name:
rule_type: composite
description: |
This rule checks ...

success_criterion:
- x.x.x # (Name of Success Criterion)
accessibility_requirements: # Remove whatever is not applicable
wcag20:x.x.x: # <Name of Success Criterion> (A | AA | AAA)
forConformance: true | false
failed: not satisfied
passed: satisfied | further testing needed
inapplicable: satisfied | further testing needed

atomic_rules:
-
aria11:x.x.x: # <Heading in WAI-ARIA>
forConformance: true | false
failed: not satisfied
passed: satisfied | further testing needed
inapplicable: satisfied | further testing needed

wcag-technique:x.x.x: # <Technique title>
forConformance: true | false
failed: not satisfied
passed: satisfied | further testing needed
inapplicable: satisfied | further testing needed

input_rules:
- # Include the ID of the rule

authors:
- # (full names as found in `contributors` property in `package.json` - if not yet listed, please have authors added to the list)
---

## Aggregation Definition

### Applicability
## Applicability

The rule applies to any (??) element ...
jeeyyy marked this conversation as resolved.
Show resolved Hide resolved

### Expectation
## Expectation (1)

For each test target, the outcome of (at least one of / all of / any of etc.) the following rules is (passed / failed / etc.):
For each test target, the outcome of (at least one of | all of | any of etc.) the following rules is (passed / failed / etc.):

- (list atomic rules that are used in this composite rule)
-
- [Rule name](relative_link_to_rule.html)
- ...

## Assumptions

_There are currently no assumptions._

## Accessibility support
## Accessibility Support

_There are no major accessibility support issues known for this rule._

Expand All @@ -43,42 +58,42 @@ _There are no major accessibility support issues known for this rule._

### Passed

#### Passed example 1
#### Passed Example 1

Description...

```html
<!-- code -->
```

#### Passed example 2
#### Passed Example 2

...

### Failed

#### Failed example 1
#### Failed Example 1

Description...

```html
<!-- code -->
```

#### Failed example 2
#### Failed Example 2

...

### Inapplicable

#### Inapplicable example 1
#### Inapplicable Example 1

Description...

```html
<!-- code -->
```

#### Inapplicable example 2
#### Inapplicable Example 2

...