|
| 1 | +# Issue Template for Epic to create and apply solution |
| 2 | + |
| 3 | +## 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. |
| 5 | + |
| 6 | +## 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 Alert/Aria/Contrast Error/Error. |
| 8 | + |
| 9 | +- 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. |
| 10 | +- If this is not the correct template, see [WIKI and Issue templates](index.md) for a list of other templates available. |
| 11 | + |
| 12 | +## Template |
| 13 | + |
| 14 | +### Labels |
| 15 | +Add the following labels and any missing labels that apply |
| 16 | +``` |
| 17 | +feature: Accessibility |
| 18 | +``` |
| 19 | +``` |
| 20 | +p-feature: [REPLACE WITH PAGE NAME] |
| 21 | +``` |
| 22 | +### Title |
| 23 | +``` |
| 24 | +Epic: WAVE: [REPLACE WITH Alert/Aria/Contrast Error/Error] |
| 25 | +``` |
| 26 | +### Body |
| 27 | +````` |
| 28 | +<!-- Customize this epic issue by replacing all of the content in [ ] --> |
| 29 | +
|
| 30 | +### Overview |
| 31 | +
|
| 32 | +We need to make issues that will create, apply and document a solution for [REPLACE WITH /Aria/Contrast Error/Error] so that it can get fixed on the site and documented for future developers |
| 33 | +
|
| 34 | +### Details |
| 35 | +Category: [REPLACE WITH ONE OF THESE CATEGORIES /Aria/Contrast Error/Error] |
| 36 | +Name: [REPLACE WITH NAME OF /Aria/Contrast Error/Error] |
| 37 | +(The Accessibility wiki for this [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] has no solution yet) |
| 38 | +
|
| 39 | +known pages (there might be others): |
| 40 | +1. [REPLACE WITH NAME OF PAGE NAME 1] |
| 41 | +1. [REPLACE WITH NAME OF PAGE NAME N] |
| 42 | +
|
| 43 | +This epic will do the following |
| 44 | +- create a new issue to fix the problem on one page and update the wiki page with the solution, once accepted. |
| 45 | +- create any follow-on issues to fix any other occurrences of this problem |
| 46 | +
|
| 47 | +### Action Items |
| 48 | +- [ ] Go to the Solutions Index (resource 1.02) and add the link to the specific page for this problem 1.02.01 |
| 49 | +- [ ] Copy the first issue template (resource 1.04) |
| 50 | +- [ ] Use the template content to create a new issue for the `[REPLACE WITH FIRST PAGE NAME]` page |
| 51 | + - [ ] Add the following labels |
| 52 | + - role: front-end |
| 53 | + - size: missing |
| 54 | + - p-feature: [REPLACE WITH NAME OF PAGE] |
| 55 | + - feature: Accessibility |
| 56 | + - level: missing |
| 57 | + - deck: add to staging |
| 58 | + - ready for dev lead |
| 59 | + - priority: MUST HAVE |
| 60 | + - [ ] add milestone: launch |
| 61 | + - Customize the draft issue resources |
| 62 | + - [ ] In this issue use the content in resource 1.03.01 (Product Documentation) to update the draft's issue resource 1.02.01, 1.02.02 |
| 63 | + - [ ] In this issue use the content in resource 1.01.01 (spreadsheet) to update the link to the spreadsheet in draft issue's |
| 64 | + - [ ] open the spreadsheet link and find the row number, and add it to the draft issues's resource 1.03.01resource 1.03 |
| 65 | +- [ ] In this issue, add issue to Sub Issue section below |
| 66 | +- [ ] Copy the second issue template (resource 1.05) |
| 67 | +- [ ] Use the template content to create a new issue(s) for the remaining pages under Known pages above |
| 68 | +- [ ] Customize the draft |
| 69 | + - [ ] Add the following labels |
| 70 | + - role: front-end |
| 71 | + - size: missing |
| 72 | + - p-feature: [REPLACE WITH FIRST PAGE NAME] |
| 73 | + - feature: Accessibility |
| 74 | + - level: missing |
| 75 | + - deck: add to staging |
| 76 | + - ready for dev lead |
| 77 | + - priority: MUST HAVE |
| 78 | + - Customize the draft issue resources |
| 79 | + - [ ] 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 |
| 80 | + - [ ] 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 |
| 81 | + - [ ] 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 [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 |
| 85 | + - [ ] Make additional issues |
| 86 | +
|
| 87 | +
|
| 88 | +### Resources |
| 89 | +- 1.01 [TDM WAVE Accessibility Audit Spreadsheet, tab: 2. Audit Log](https://docs.google.com/spreadsheets/d/1qiAqR9LH-Gd4LO3aOs0yUy174o5LOmnuU6Bz671mKsY/edit?gid=0#gid=0) |
| 90 | + - 1.01.01 [TDM WAVE Accessibility Audit Spreadsheet, tab: 2. Audit Log, filter: [REPLACE WITH NAME OF FILTER FOR Alert/Aria/Contrast Error/Error] |
| 91 | +- 1.02 [WCAG: Known Issues and Solutions](https://hackforla.github.io/accessibility/known-issues-and-solutions) |
| 92 | + - 1.02.01 https://hackforla.github.io/accessibility/known-issues-and-solutions/solutions-index/[REPLACE WITH PAGE NAME WITH DASHES]/ |
| 93 | +- 1.03 WIKI: Product Documentation: https://github.com/hackforla/tdm-calculator/wiki/Product-Documentation |
| 94 | + - 1.03.01 WIKI: Product Documentation, [REPLACE WITH PAGE NAME] page: |
| 95 | +
|
| 96 | +#### 1.04 first issue Template |
| 97 | +Title |
| 98 | +``` |
| 99 | +Dev: fix [REPLACE WITH Alert/Aria/Contrast Error/Error] on [REPLACE WITH PAGE NAME] page |
| 100 | +``` |
| 101 | +Body |
| 102 | +``` |
| 103 | +### Overview |
| 104 | +We need to fix the 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. |
| 105 | +
|
| 106 | +#### Details |
| 107 | +Category: [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] |
| 108 | +Name: [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] |
| 109 | +(The Accessibility wiki for this Alert/Aria/Contrast Error/Error has no solution yet) |
| 110 | +
|
| 111 | +Page that will be worked on: |
| 112 | +[REPLACE WITH NAME OF PAGE NAME] |
| 113 | +
|
| 114 | +### Action Items |
| 115 | +- [ ] Review wiki page: Accessibility, How to run the WAVE browser extension (Resource 1.01) |
| 116 | + - [ ] Install the WAVE browser extension |
| 117 | +- [ ] Log in as the user indicated (resource 1.02.01) |
| 118 | +- [ ] navigate to the page you are going to fix (resource 1.02.02) |
| 119 | +- [ ] 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. |
| 120 | +- [ ] Run the WAVE extension with no elements focused, or clicked (resource 1.04) |
| 121 | +- [ ] 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 [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] guidance section) |
| 123 | +- [ ] Apply solution |
| 124 | +- [ ] write and add the appropriate details to the `Project Team Solution` section (resource 1.05.01.01) |
| 125 | +- [ ] Submit PR (include link to `Project Team Solution` section (resource 1.05.01.01) |
| 126 | +- [ ] Add PR to spreadsheet in PR column next to [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] (resource 1.03) |
| 127 | +- [ ] On this issue |
| 128 | + - [ ] Add labels: |
| 129 | + - `ready for accessibility lead` |
| 130 | + - `ready for product` |
| 131 | + - [ ] Change status to: `Technical Review` |
| 132 | +- [ ] Get sign-off on WIKI page by |
| 133 | + - [ ] Accessibility lead |
| 134 | + - [ ] Product lead |
| 135 | +- [ ] release the dependencies on |
| 136 | + - [INSERT LINK TO NEXT ISSUE(s)] |
| 137 | + - [INSERT LINK TO EPIC] |
| 138 | +
|
| 139 | +### Resources/Instructions |
| 140 | +- 1.01[How to run the WAVE browser extension](https://hackforla.github.io/accessibility/getting-started/wave-browser-extension/) |
| 141 | +- 1.02 Application details |
| 142 | + - 1.02.01 User Profile Required: [REPLACE WITH USER TYPE: visitor (not logged in)/user/admin/security admin/] |
| 143 | + - 1.02.02 Page URL: http://tdm-dev.azurewebsites.net/[REPLACE WITH PAGE URL] |
| 144 | + - Requires sign in: [REPLACE WITH TRUE OR FALSE] |
| 145 | + - Can access page directly from URL: [REPLACE WITH TRUE OR FALSE] |
| 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]] |
| 147 | + - Spreadsheet Row(s): [REPLACE WITH ROW NUMBERS] |
| 148 | +- 1.04 https://hackforla.github.io/accessibility/getting-started/perform-wave-audit |
| 149 | +- 1.05 [Accessibility Known Issues Index](https://hackforla.github.io/accessibility/known-issues-and-solutions/solutions-index/) |
| 150 | + - 1.05.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]] |
| 151 | + - 1.05.01.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], project-team-solution] |
| 152 | +
|
| 153 | +Additional reading (optional) |
| 154 | +- TDM [Accessibility Audits](https://hackforla.github.io/accessibility/) |
| 155 | +
|
| 156 | +<!- DELETE THE SLIDES SECTION IF THIS IS NOT FOR THE TDM TEAM --> |
| 157 | +#### Slides |
| 158 | +- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg) |
| 159 | + - [Staging Deck, slide] |
| 160 | +- Release deck |
| 161 | + - [2026-01-20 Release deck, slide ] |
| 162 | +``` |
| 163 | +
|
| 164 | +#### 1.05 Second Issue Template |
| 165 | +Title |
| 166 | +``` |
| 167 | +Dev: fix [REPLACE WITH Alert/Aria/Contrast Error/Error] on [REPLACE WITH PAGE NAME] page |
| 168 | +``` |
| 169 | +Body |
| 170 | +```` |
| 171 | +### Overview |
| 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. |
| 173 | +
|
| 174 | +#### Details |
| 175 | +Category: [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] |
| 176 | +Name: [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] |
| 177 | +(The Accessibility wiki for this [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] has a solution) |
| 178 | +
|
| 179 | +Page that will be worked on: |
| 180 | +[REPLACE WITH NAME OF PAGE NAME] |
| 181 | +
|
| 182 | +### Action Items |
| 183 | +- [ ] Review wiki page: Accessibility, How to run the WAVE browser extension (Resource 1.01) |
| 184 | + - [ ] Install the WAVE browser extension |
| 185 | +- [ ] Log in as the user indicated (resource 1.02.01) |
| 186 | +- [ ] navigate to the page you are going to fix (resource 1.02.02) |
| 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. |
| 188 | +- [ ] Run the WAVE extension with no elements focused, or clicked |
| 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) |
| 191 | +- [ ] Apply solution |
| 192 | +- [ ] Submit PR |
| 193 | +- [ ] Add PR to spreadsheet in PR column next to [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] (resource 1.03) |
| 194 | +- [ ] On this issue |
| 195 | + - [ ] Add labels: |
| 196 | + - `ready for accessibility lead` |
| 197 | + - [ ] Change status to: `Technical Review` |
| 198 | + - to the epic #2897 |
| 199 | + - [ ] Add the label `ready for product` |
| 200 | + - [ ] Add this comment |
| 201 | + ``` |
| 202 | + - [#REPLACE WITH THIS ISSUE NUMBER] is closed. Please review to see if there are any remaining instances of this problem |
| 203 | + ``` |
| 204 | +
|
| 205 | +### Resources/Instructions |
| 206 | +- 1.01[How to run the WAVE browser extension](https://github.com/hackforla/accessibility/blob/main/docs/getting-started/wave-browser-extension.md) |
| 207 | +- 1.02 Application details |
| 208 | + - 1.02.01 User Profile Required: [REPLACE WITH USER TYPE: visitor (not logged in)/user/admin/security admin/] |
| 209 | + - 1.02.02 Page URL: http://tdm-dev.azurewebsites.net/[REPLACE WITH PAGE URL] |
| 210 | + - Requires sign in: [REPLACE WITH TRUE OR FALSE] |
| 211 | + - Can access page directly from URL: [REPLACE WITH TRUE OR FALSE] |
| 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]] |
| 213 | + - Spreadsheet Row(s): [REPLACE WITH ROW NUMBERS] |
| 214 | +- 1.04 [Accessibility Known Issues Index](https://github.com/hackforla/accessibility/blob/main/docs/known-issues-and-solutions/solutions-index/index.md) |
| 215 | + - 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]] |
| 216 | + - 1.04.01.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], project-team-solution] |
| 217 | +
|
| 218 | +Additional reading (optional) |
| 219 | +- https://hackforla.github.io/accessibility/ |
| 220 | +
|
| 221 | +#### Slides |
| 222 | +- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg) |
| 223 | + - [Staging Deck, slide ] |
| 224 | +- Release deck |
| 225 | + - [2026-01-20 Release deck, slide ] |
| 226 | +```` |
| 227 | +
|
| 228 | +<!- DELETE THE SLIDES SECTION IF THIS IS NOT FOR THE TDM TEAM --> |
| 229 | +#### Slides |
| 230 | +- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg) |
| 231 | + - [Staging Deck, slide [slide number]] - N/A |
| 232 | +- Release deck |
| 233 | + - [2026-01-20 Release deck, slide [slide number] - N/A |
| 234 | +````` |
0 commit comments