Skip to content

Commit b2de4fb

Browse files
Update issue-template-epic-create-apply-and-document-solution.md
update template
1 parent 627c8c0 commit b2de4fb

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

docs/wiki-and-issue-templates/issue-template-epic-create-apply-and-document-solution.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Issue Template for Epic to create and apply solution
22

33
## What does this template do?
4-
This issue template creates an epic issue and will direct the person working on the epic issue in how to create child issues (using a template that is customized during the epic creation). The scope of work of the epic will fix one specific Alert/Aria/Contrast Error/Error found on your website and update this WIKI to share that solution for future reference.
4+
This issue template creates an epic issue and will direct the person working on the epic issue in how to create child issues (using a template that is customized during the epic creation). The scope of work of the epic will fix one specific [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] found on your website and update this WIKI to share that solution for future reference.
55

66
## When should this template be used?
7-
Only use this template if there is no solution in the index and there are two or more pages with the same error.
7+
Only use this template if there is no solution in the index and there are two or more pages with the same [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error].
88

99
- to confirm there is no solution, go to [Known issues and solutions index](../../known-issues-and-solutions/solutions-index), and identify if the page is in the Completed or Drafts section. If it is in the Drafts section, there is no solution yet.
1010
- If this is not the correct template, see [WIKI and Issue templates](index.md) for a list of other templates available.
@@ -21,7 +21,7 @@ p-feature: [REPLACE WITH PAGE NAME]
2121
```
2222
### Title
2323
```
24-
Epic: WAVE: [[REPLACE WITH Alert/Aria/Contrast Error/Error]
24+
Epic: WAVE: [REPLACE WITH Alert/Aria/Contrast Error/Error]
2525
```
2626
### Body
2727
`````
@@ -34,7 +34,7 @@ We need to make issues that will create, apply and document a solution for [REPL
3434
### Details
3535
Category: [REPLACE WITH ONE OF THESE CATEGORIES /Aria/Contrast Error/Error]
3636
Name: [REPLACE WITH NAME OF /Aria/Contrast Error/Error]
37-
(The Accessibility wiki for this Alert/Aria/Contrast Error/Error has no solution yet)
37+
(The Accessibility wiki for this [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] has no solution yet)
3838
3939
known pages (there might be others):
4040
1. [REPLACE WITH NAME OF PAGE NAME 1]
@@ -79,9 +79,9 @@ This epic will do the following
7979
- [ ] In this issue use the content in resource Product Documentation 1.03.01 to update the draft's issue resource 1.02.01, 1.02.02
8080
- [ ] In this issue use the content in resource 1.01.01 (spreadsheet) to update the link to the spreadsheet in draft issue's resource 1.03
8181
- [ ] open the spreadsheet link and find the row number, and add it to the draft issues's resource 1.03.01
82-
- [ ] Once both those issues are closed, run WAVE and check all other pages for this Alert/Aria/Contrast Error/Error; ignore all other Alert/Aria/Contrast Error/Error. Check user interactions on the page to ensure that the Alert/Aria/Contrast Error/Error isn't hidden by an interaction. Check one of the following below:
83-
- [ ] No additional instances of this Alert/Aria/Contrast Error/Error found
84-
- [ ] New instances of these Alert/Aria/Contrast Error/Error found
82+
- [ ] Once both those issues are closed, run WAVE and check all other pages for this [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]; ignore all other [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]. Check user interactions on the page to ensure that the [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] isn't hidden by an interaction. Check one of the following below:
83+
- [ ] No additional instances of this [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] found
84+
- [ ] New instances of these [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] found
8585
- [ ] Make additional issues
8686
8787
@@ -119,11 +119,11 @@ Page that will be worked on:
119119
- [ ] Open the TDM WAVE Accessibility Audit Spreadsheet, for this Alert/Aria/Contrast Error/Error (resource 1.03) and find the row that relates to this issues page.
120120
- [ ] Run the WAVE extension with no elements focused, or clicked (resource 1.04)
121121
- [ ] Find the [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] win WAVE shown in the Spreadsheet (1.03)
122-
- [ ] This [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] has been resolved on other pages, so look at the other issues where this was solved (resource 1.05.01 see Project Team Error guidance section)
122+
- [ ] This [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] has been resolved on other pages, so look at the other issues where this was solved (resource 1.05.01 see Project Team [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] guidance section)
123123
- [ ] Apply solution
124124
- [ ] write and add the appropriate details to the `Project Team Solution` section (resource 1.05.01.01)
125125
- [ ] Submit PR (include link to `Project Team Solution` section (resource 1.05.01.01)
126-
- [ ] Add PR to spreadsheet in PR column next to Alert/Aria/Contrast Error/Error (resource 1.03)
126+
- [ ] Add PR to spreadsheet in PR column next to [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] (resource 1.03)
127127
- [ ] On this issue
128128
- [ ] Add labels:
129129
- `ready for accessibility lead`
@@ -143,7 +143,7 @@ Page that will be worked on:
143143
- 1.02.02 Page URL: http://tdm-dev.azurewebsites.net/[REPLACE WITH PAGE URL]
144144
- Requires sign in: [REPLACE WITH TRUE OR FALSE]
145145
- Can access page directly from URL: [REPLACE WITH TRUE OR FALSE]
146-
- 1.03 [TDM WAVE Accessibility Audit Spreadsheet, tab: 2. Audit Log, filter: Alert/Aria/Contrast Error/Error: [REPLACE WITH FILTER NAME]]
146+
- 1.03 [TDM WAVE Accessibility Audit Spreadsheet, tab: 2. Audit Log, filter: [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]: [REPLACE WITH FILTER NAME]]
147147
- Spreadsheet Row(s): [REPLACE WITH ROW NUMBERS]
148148
- 1.04 https://hackforla.github.io/accessibility/getting-started/perform-wave-audit
149149
- 1.05 [Accessibility Known Issues Index](https://hackforla.github.io/accessibility/known-issues-and-solutions/solutions-index/)
@@ -169,12 +169,12 @@ Dev: fix [REPLACE WITH Alert/Aria/Contrast Error/Error] on [REPLACE WITH PAGE NA
169169
Body
170170
````
171171
### Overview
172-
We need to fix the Alert: [REPLACE WITH Alert/Aria/Contrast Error/Error](s) on [REPLACE WITH PAGE NAME] so that page can be WCAG compliant.
172+
We need to fix the [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]: [REPLACE WITH Alert/Aria/Contrast Error/Error](s) on [REPLACE WITH PAGE NAME] so that page can be WCAG compliant.
173173
174174
#### Details
175175
Category: [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error]
176176
Name: [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]
177-
(The Accessibility wiki for this Alert/Aria/Contrast Error/Error has a solution)
177+
(The Accessibility wiki for this [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] has a solution)
178178
179179
Page that will be worked on:
180180
[REPLACE WITH NAME OF PAGE NAME]
@@ -184,13 +184,13 @@ Page that will be worked on:
184184
- [ ] Install the WAVE browser extension
185185
- [ ] Log in as the user indicated (resource 1.02.01)
186186
- [ ] navigate to the page you are going to fix (resource 1.02.02)
187-
- [ ] Open the TDM WAVE Accessibility Audit Spreadsheet, for this Alert/Aria/Contrast Error/Error (resource 1.03) and find the row that relates to this issues page.
187+
- [ ] Open the TDM WAVE Accessibility Audit Spreadsheet, for this [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] (resource 1.03) and find the row that relates to this issues page.
188188
- [ ] Run the WAVE extension with no elements focused, or clicked
189-
- [ ] Find the Alert/Aria/Contrast Error/Error referenced in the Spreadsheet (1.03)
190-
- [ ] This Alert/Aria/Contrast Error/Error has been resolved on other pages, so review `Project Team Solution` section (resource 1.04.01.01)
189+
- [ ] Find the [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] referenced in the Spreadsheet (1.03)
190+
- [ ] This [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] has been resolved on other pages, so review `Project Team Solution` section (resource 1.04.01.01)
191191
- [ ] Apply solution
192192
- [ ] Submit PR
193-
- [ ] Add PR to spreadsheet in PR column next to Alert (resource 1.03)
193+
- [ ] Add PR to spreadsheet in PR column next to [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] (resource 1.03)
194194
- [ ] On this issue
195195
- [ ] Add labels:
196196
- `ready for accessibility lead`
@@ -209,7 +209,7 @@ Page that will be worked on:
209209
- 1.02.02 Page URL: http://tdm-dev.azurewebsites.net/[REPLACE WITH PAGE URL]
210210
- Requires sign in: [REPLACE WITH TRUE OR FALSE]
211211
- Can access page directly from URL: [REPLACE WITH TRUE OR FALSE]
212-
- 1.03 [TDM WAVE Accessibility Audit Spreadsheet, tab: 2. Audit Log, filter: Alert/Aria/Contrast Error/Error: [REPLACE WITH FILTER NAME]]
212+
- 1.03 [TDM WAVE Accessibility Audit Spreadsheet, tab: 2. Audit Log, filter: [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]: [REPLACE WITH FILTER NAME]]
213213
- Spreadsheet Row(s): [REPLACE WITH ROW NUMBERS]
214214
- 1.04 [Accessibility Known Issues Index](https://github.com/hackforla/accessibility/blob/main/docs/known-issues-and-solutions/solutions-index/index.md)
215215
- 1.04.01 [WAVE Known Accessibility Issue: [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] - [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]]

0 commit comments

Comments
 (0)