Skip to content

Issue Template for Epic to create, apply and document code solution - for 1 page

What does this template do?

This issue template creates an epic issue and will direct the person working on the epic issue in how to create child issue (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 a single webpage and update this WIKI to share that solution for future reference.

When should this template be used?

Only use this template if there is no solution in the index and there only 1 page with the Alert/Aria/Contrast Error/Error.

  • to confirm there is no solution, go to Known issues and 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.
  • If this is not the correct template, see WIKI and Issue templates for a list of other templates available.

Template

Labels

Add the following labels and any missing labels that apply 

feature: Accessibility

p-feature: [REPLACE WITH PAGE NAME]

Title

Epic: WAVE: [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error](s): [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]

Body

<!-- Customize this epic issue by replacing all of the content in [ ] -->

### Overview

We need to make an issue that will create, apply and document a solution for [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error]: [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] so that it can get fixed on the site and documented for future developers

### Details
Category: [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error]
Name: [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]
(The Accessibility wiki for this [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] has no solution yet)

known page (there might be others):
1. [REPLACE WITH NAME OF PAGE NAME 1]

This epic will do the following
- create a new issue to fix the problem on one page and update the wiki page with the solution, once accepted.
- check to see if this [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] is on any other pages on the site.

### Action Items
- [ ] Go to the Solutions Index (resource 1.02) and add the link to the specific page for this problem 1.02.01
- [ ] Copy the first issue template (resource 1.04) 
- [ ] Use the template content to create a new issue for the `[REPLACE WITH FIRST PAGE NAME]` page
   - [ ] Add the following labels
      - role: front-end
      - size: missing
      - p-feature: [REPLACE WITH NAME OF PAGE]
      - feature: Accessibility
      - level: missing
      - deck: add to staging
      - ready for dev lead
      - priority: MUST HAVE
   - [ ] add milestone: launch
   - Customize the draft issue resources
      - [ ] 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
      - [ ] In this issue use the content in resource 1.01.01 (spreadsheet) to update the link to the spreadsheet in draft issue's
         - [ ] open the spreadsheet link and find the row number, and add it to the draft issues's resource 1.03.01resource 1.03
- [ ] In this issue, add issue to Sub Issue section below
- [ ] Once the above issue is closed, run WAVE and check all other pages for this [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error]: [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]; ignore all other Alerts and Errors.  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:
   - [ ] No additional instances of this [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] found
   - [ ] New instances of these [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] found
      - [ ] Use this template to make a new epic: [Epic: Apply code solution for 1 or more pages](https://hackforla.github.io/accessibility/wiki-and-issue-templates/issue-template-epic-apply-solution/)


### Resources
- 1.01 [TDM WAVE Accessibility Audit Spreadsheet, tab: 2. Audit Log](https://docs.google.com/spreadsheets/d/1qiAqR9LH-Gd4LO3aOs0yUy174o5LOmnuU6Bz671mKsY/edit?gid=0#gid=0)
   - 1.01.01 [TDM WAVE Accessibility Audit Spreadsheet, tab: 2. Audit Log, filter: [REPLACE WITH NAME OF FILTER FOR Alert/Aria/Contrast Error/Error's]
- 1.02 [WCAG: Known Issues and Solutions](https://hackforla.github.io/accessibility/known-issues-and-solutions)
  - 1.02.01 https://hackforla.github.io/accessibility/known-issues-and-solutions/solutions-index/[REPLACE WITH PAGE NAME WITH DASHES]/
- 1.03 WIKI: Product Documentation: https://github.com/hackforla/tdm-calculator/wiki/Product-Documentation
   - 1.03.01 WIKI: Product Documentation, [REPLACE WITH PAGE NAME] page: 

#### 1.04 issue Template
Title
```
Dev: fix [REPLACE WITH Alert/Aria/Contrast Error/Error] on [REPLACE WITH PAGE NAME] page
```
Body
```
### Overview
We need to fix the [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error](s): [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error](s) on [REPLACE WITH PAGE NAME] so that page can be WCAG compliant.

#### Details
Category: [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error]
Name: [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error]
(The Accessibility wiki for this [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] has no solution yet)

Page that will be worked on:
[REPLACE WITH NAME OF PAGE NAME]

### Action Items
- [ ] Review wiki page: Accessibility, How to run the WAVE browser extension (Resource 1.01)
   - [ ] Install the WAVE browser extension
- [ ] Log in as the user indicated (resource 1.02.01) 
- [ ] navigate to the page you are going to fix (resource 1.02.02)
- [ ] 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.
- [ ] Run the WAVE extension with no elements focused, or clicked (resource 1.04)
- [ ] Find the [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] shown in the Spreadsheet (1.03)
- [ ] This [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error]: [REPLACE WITH NAME OF Alert/Aria/Contrast Error/Error] on [REPLACE WITH PAGE NAME] 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 ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] guidance section)
- [ ] Apply solution
- [ ] write and add the appropriate details to the `Project Team Solution` section (resource 1.05.01.01)
- [ ] Submit PR (include link to `Project Team Solution` section (resource 1.05.01.01)
- [ ] Add PR to spreadsheet in PR column next to [REPLACE WITH ONE OF THESE CATEGORIES Alert/Aria/Contrast Error/Error] (resource 1.03)
- [ ] On this issue
   - [ ] Add labels: 
      - `ready for accessibility lead`
      - `ready for product`
   - [ ] Change status to: `Technical Review`
- [ ] Get sign-off on WIKI page by
   - [ ] Accessibility lead
   - [ ] Product lead
- [ ] release the dependencies on 
   - [INSERT LINK TO NEXT ISSUE(s)]
   - [INSERT LINK TO EPIC]

### Resources/Instructions
- 1.01 [How to run the WAVE browser extension](https://hackforla.github.io/accessibility/getting-started/wave-browser-extension/)
- 1.02 Application details
   - 1.02.01 User Profile Required: [REPLACE WITH USER TYPE: visitor (not logged in)/user/admin/security admin/]
   - 1.02.02 Page URL: http://tdm-dev.azurewebsites.net/[REPLACE WITH PAGE URL]
      - Requires sign in: [REPLACE WITH TRUE OR FALSE]
      - Can access page directly from URL: [REPLACE WITH TRUE OR FALSE]
- 1.03 [TDM WAVE Accessibility Audit Spreadsheet, tab: 2. Audit Log, filter: [REPLACE WITH FILTER NAME]]
   -  Spreadsheet Row(s): [REPLACE WITH ROW NUMBERS]
- 1.04 https://hackforla.github.io/accessibility/getting-started/perform-wave-audit
- 1.05 [Accessibility Known Issues Index](https://hackforla.github.io/accessibility/known-issues-and-solutions/solutions-index/)
    - 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]]
       - 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]

Additional reading (optional)
- TDM [Accessibility Audits](https://hackforla.github.io/accessibility/)

<!- DELETE THE SLIDES SECTION IF THIS IS NOT FOR THE TDM TEAM -->
#### Slides
- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg)
   - [Staging Deck, slide]
- Release deck
   - [2026-01-20 Release deck, slide ]
```

<!- DELETE THE SLIDES SECTION IF THIS IS NOT FOR THE TDM TEAM -->
#### Slides
- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg)
   - [Staging Deck, slide [slide number]] - N/A
- Release deck
   - [2026-01-20 Release deck, slide [slide number] - N/A