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

Simplification of issue template for Level AAA criteria development #536

Merged
merged 1 commit into from
Oct 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions .github/ISSUE_TEMPLATE/template-for-success-criterion.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Template for Success Criterion
about: Adds guidance on how to open issues for specific success criteria
title: 'Success Criterion @@ x.x.x @@: @@ Short name @@ (Level @@ x @@)'
title: '@@ x.x.x Short name @@ (Level AAA)'
labels: ''
assignees: ''

Expand All @@ -10,14 +10,11 @@ assignees: ''
_**Instructional note**: Places where the text needs to be replaced are denoted using "@@" (two at signs) so you can easily search for and know what to change. For example, on the first line of the template:_
* _where "@@ x.x.x @@" is found, replace that text with the Success Criterion number. (e.g. 1.1.1)_
* _where "@@ Short name @@ is found, replace with the short name of the Success Criterion (e.g. Non-text Content)_
* _where "@@ x @@" is found, replace with the SC level. (e.g. A)_

When completed, it would read:

**Success Criterion 1.1.1: Non-text Content (Level A)**
***

From [Success Criterion @@ x.x.x @@](@@ URL for the SC in WCAG 2.2 @@):
#### [@@ x.x.x @@](@@ URL for the SC in WCAG 2.2 @@)

(Level AAA)

>@@ Copy in text of the SC from [WCAG 2.2](https://www.w3.org/TR/WCAG22/) along with any notes. Use [markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) to format properly, as needed. @@

Expand All @@ -27,8 +24,8 @@ From [Success Criterion @@ x.x.x @@](@@ URL for the SC in WCAG 2.2 @@):
_**Instructional note**: Analyze the text of the SC for words such as "Web", "page", "content", "pages", "user agent", "markup" which will key you into the need for substitution verbiage. Use one of the following statements, depending on what you think is correct and remove the bullet markdown. Add the following to the bullet if the SC refers to Conformance Requirement 5: @@ , and removing “See Conformance Requirement 5: Non-Interference”. @@_
***

- This applies directly as written, and as described in [Intent from Understanding Success Criterion @@ x.x.x @@](@@ URL of WCAG 2.2 understanding#intent @@) (also provided below).
- This applies directly as written, and as described in [Intent from Understanding Success Criterion @@ x.x.x @@](@@ URL of WCAG 2.2 understanding#intent @@) (also provided below), replacing “@@ Web-focused language @@” with “@@ replacement non-web language @@”, “@@ page-related language @@” with “@@ appropriate non-web language @@”.
- This applies directly as written, and as described in [Intent from Understanding Success Criterion @@ x.x.x @@](@@ URL of WCAG 2.2 understanding#intent @@).
- This applies directly as written, and as described in [Intent from Understanding Success Criterion @@ x.x.x @@](@@ URL of WCAG 2.2 understanding#intent @@), replacing “@@ Web-focused language @@” with “@@ replacement non-web language @@”, “@@ page-related language @@” with “@@ appropriate non-web language @@”.

With these substitutions, it would read: @@ Omit this line if no substitutions are needed. @@

Expand All @@ -39,3 +36,7 @@ _**Instructional note**: If you think notes are needed for specific areas of dif
***

> **Note:** @@ Whatever note is needed. Omit this line if not needed. @@

***
**For WCAG2ICT consideration:** Add anything the TF should think about, consider adding, or review.
***
Loading