Skip to content

Commit

Permalink
[DOCS] Add 508 Audit Templates
Browse files Browse the repository at this point in the history
Adding 508 Audit Epic and Defect templates
  • Loading branch information
srancour authored Oct 1, 2024
1 parent 09c6776 commit bd28f7d
Show file tree
Hide file tree
Showing 59 changed files with 183 additions and 97 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/508-accessibility-audit-defect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: 508 Accessibility Audit Defect
about: Capture defects from 508 office audit
title: Defect <number> <defect description>
labels: 508-audit, accessibility, Needs refining
assignees: ''

---

## Description or Additional Context
Description from 508 office

## Example
Example and any screenshots

### Code snippet


### Steps to reproduce


## Recommended resolution


## Defect Criterion
[Defect number and name](urlToGuideline) - Defect description

### Users affected
- List user types (e.g. keyboard only, screen reader, etc.)

## Teams that this affects:
- [x] Team name
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/508-accessibility-audit-epic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: 508 Accessibility Audit Epic
about: Epic for 508 office audit
title: "[Epic} 508 Audit <Date of audit>"
labels: 508-audit, accessibility, Epic, Needs refining
assignees: ''

---

## Audit Document

## Severity Matrix

- A product with no defects has a score of 100
- Each open 'Critical' defect lowers the score by 15
- Each open 'High' defect lowers the score by 5
- Each open 'Medium' defect lowers the score by 2.5
- Each open 'Low' defect lowers the score by 1
- Accessibility defects have no effect on the score.

| Severity | Number |
|----------|--------|
| Critical | x |
| High | x |
| Medium | x |
| Low | x |
| TOTAL | x |
| Score | x |

## Timeline
This was completed on <date of audit> and the 508 office is planning on doing an audit of issues every 6 months for all projects. This should try to be addressed by <date 6 months from now>.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/__cms-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Task
about: A task for the CMS team.
title: "<Insert summary of task>"
labels: Needs refining
labels: Needs refining, UX writing
assignees: ''

---
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/ap-defect.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
name: (AP) Defect
name: "(AP) Defect"
about: Work to fix a problem with existing functionality
title: "<Short description of the functional problem>"
labels: Accelerated Publishing, Defect
assignees: ''

---

Expand Down Expand Up @@ -43,4 +44,3 @@ Log messages here
<!-- Provide any information about why the bug is happening. Links to tickets where the work was originally done are helpful. -->
<!-- This is the place for info about the technical failure. -->
<!-- This probably will not be filled out when the ticket is initially created. -->

5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/ap-epic.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
name: (AP) Epic
name: "(AP) Epic"
about: A collection of work towards a defined goal
title: "[Epic][AP] <brief description of value>"
labels: Needs refining, Accelerated Publishing, Epic
labels: Accelerated Publishing, Epic, Needs refining
assignees: ''

---

Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/ap-sprint-overview.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
name: (AP) Sprint Overview
name: "(AP) Sprint Overview"
about: High priority goals and tickets grouped by focus area
title: "[AP] Sprint ##"
labels: Needs refining, Accelerated Publishing
labels: Accelerated Publishing, Needs refining
assignees: ''

---

Expand Down Expand Up @@ -38,4 +39,3 @@ labels: Needs refining, Accelerated Publishing
## Focus area 5
- [ ] Add issues
```

7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/ap-task.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
name: (AP) Feature
name: "(AP) Feature"
about: New or work or enhancements
title: "<brief summary of value/outcome>"
labels: Needs refining, Accelerated Publishing
labels: Accelerated Publishing, Needs refining
assignees: ''

---

## Requirements
<!-- one to two sentences about the value being delivered; why are we doing this? -->
<!-- for very technical implementation tasks a more direct explanation is fine, but otherwise avoid solutions here. -->
Expand All @@ -17,4 +19,3 @@ labels: Needs refining, Accelerated Publishing
## Background & implementation details
<!-- any suppporting information, links etc. -->
<!-- solution-specific discussion is great here. -->

6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/cms-collaboration-cycle-feedback.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
name: CMS Collaboration Cycle Feedback
about: Use this template for CMS Team practice areas to provide feedback to teams going through the CMS Collaboration Cycle.
title: 'Name of Collab Touchpoint - Practice Area Feedback - Name of Project'
about: Use this template for CMS Team practice areas to provide feedback to teams
going through the CMS Collaboration Cycle.
title: Name of Collab Touchpoint - Practice Area Feedback - Name of Project
labels: CMS Team, CMS-Collab-Cycle, collab-cycle-feedback
assignees: ''

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: CMS Design System Dev Implementation
about: Use this template for Developers to implement CMS design system updates.
title: 'Implement <insert topic here> from the design system.'
title: Implement <insert topic here> from the design system.
labels: CMS design system, CMS Team, Drupal engineering, Needs refining
assignees: edmund-dunn, tonytaylor
assignees: edmund-dunn

---

Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/cms-design-system-documentation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: CMS Design System Documentation
about: Use this template for a designer to update the CMS design system documentation.
title: 'Update/add <insert topic here> in the design system documentation.'
labels: CMS design system, CMS design, CMS Team, Needs refining
assignees: BlakeOrgan
title: Update/add <insert topic here> in the design system documentation.
labels: CMS design system, CMS Team, Needs refining
assignees: ''

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
name: CMS Design System Experimental Addition Request
about: Use this template for designers outside of the CMS team to request a component or pattern be added to the CMS Design System.
title: 'Experimental Design for [component or pattern name]'
labels: CMS design system, CMS design, CMS Team, Needs refining
assignees: BlakeOrgan
about: Use this template for designers outside of the CMS team to request a component
or pattern be added to the CMS Design System.
title: Experimental Design for [component or pattern name]
labels: CMS design system, CMS Team, Needs refining
assignees: ''

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: CMS Design System Update or Addition
about: Use this template for a designer to update the CMS design system.
title: 'Update/add <insert topic here> in the design system.'
labels: CMS design system, CMS design, CMS Team, Needs refining
assignees: BlakeOrgan
title: Update/add <insert topic here> in the design system.
labels: CMS design system, CMS Team, Needs refining
assignees: ''

---

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/cms-section-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: CMS section request
about: Requests a change to the Sections hierarchy
title: ''
labels: Content governance, CMS Team
labels: CMS Team, Content governance
assignees: ''

---
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/content-audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
name: Content Audit
about: Submit a request to perform a content audit across VA.gov.
title: 'Content Audit: <description>'
labels: Content audit, CMS Team
assignees: dawnpruitt, EWashb
labels: CMS Team, Content audit
assignees: EWashb

---

Expand Down
9 changes: 5 additions & 4 deletions .github/ISSUE_TEMPLATE/content_model_spec.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
name: Content Model Specification
about: Use this template when you are specifying proposed changes to the CMS Content Model
title: "Content model specification for [PRODUCT/FEATURE]"
labels: Content Model
about: Use this template when you are specifying proposed changes to the CMS Content
Model
title: Content model specification for [PRODUCT/FEATURE]
labels: ''
assignees: ''

---
Expand All @@ -22,4 +23,4 @@ SO THAT I can implement it in Drupal
## Acceptance Criteria
- [ ] Proposed entities, fields, and field properties are documented using the [content model spec template](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/cms/content-model/drupal_content_model_spec_template.xlsx)
- [ ] Reviewed with engineering & product
- [ ] Send to CMS Collab Cycle
- [ ] Send to CMS Collab Cycle
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/cross-team-intake-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Please provide:
## Acceptance Criteria
- [ ] The Product Manager for the recommended intake team is pinged through Slack about the issue
- [ ] The Product Manager has discussed with the respective Product Owner to determine prioritization
- [ ] Any decisions made on prioritization or implementation are communicated back to the originating team
- [ ] Any decisions made on prioritization or implementation are communicated back to the originating team
11 changes: 6 additions & 5 deletions .github/ISSUE_TEMPLATE/dark-launch.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
name: "Dark launch request"
about: Request to dark launch CMS content that includes React widget, owned by CMS team
name: Dark launch request
about: Request to dark launch CMS content that includes React widget, owned by CMS
team
title: 'CMS/React content dark launch request: <content info>'
labels: Drupal engineering, Needs analysis, CMS Team
assignees: BerniXiongA6
labels: CMS Team, Drupal engineering
assignees: ''

---

Expand Down Expand Up @@ -39,4 +40,4 @@ Please tick the boxes for completed steps as we go, for cross-team visibility.
## Acceptance Criteria
- [ ] Page is verified: Live on Staging
- [ ] Page is **not** live on Prod
- [ ] Ticket is cut for production launch planning, e.g. #10627
- [ ] Ticket is cut for production launch planning, e.g. #10627
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/devops-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
name: DevOps task
about: A task for the CMS DevOps team.
title: "<Insert summary of task>"
labels: DevOps, Needs refining, CMS Team
labels: CMS Team, DevOps, Needs refining
assignees: ''

---

### Tasks:
- [ ] Task 1...
- [ ] Task 1...
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ Editor-centered
- [ ] `Efficient`: Remove distractions and create clear, straightforward paths to get the job done.
- [ ] `Approachable`: Offer friendly guidance over authoritative instruction.
- [ ] `Consistent`: Reduce user’s mental load by allowing them to fall back on pattern recognition to complete tasks.
- [ ] `Empowering`: Provide clear information to help editors make decisions about their work.
- [ ] `Empowering`: Provide clear information to help editors make decisions about their work.
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/knowledge-base-article.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
name: Knowledge Base article - Create or update
about: Use this template for new CMS Knowledge Base articles that need to be written or for updates to existing KB articles.
about: Use this template for new CMS Knowledge Base articles that need to be written
or for updates to existing KB articles.
title: 'Create new KB article or update existing article : <insert topic here>'
labels: Knowledge Base, Needs refining
assignees: ''
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/linky-update-request.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Linky Reference Update Request
about: Submit a request to update a Linky Reference
title: 'Linky Reference Update Request'
labels: "User Support"
title: Linky Reference Update Request
labels: ''
assignees: ''

---
Expand Down
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/octode-project-board-epic.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
name: Sitewide Epic - Web Governance Board
about: Epic template for Sitewide projects that need to be publicized in the Web Governance Board project view, for Public Websites and Facilities teams.
title: ""
about: Epic template for Sitewide projects that need to be publicized in the Web Governance
Board project view, for Public Websites and Facilities teams.
title: ''
labels: Epic, sitewide
assignees: ''

Expand Down
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/pw-clp-request.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: "(Sitewide) Campaign Landing Page request"
about: Request a new Campaign Landing Page, owned by Public
Websites team
about: Request a new Campaign Landing Page, owned by Public Websites team
title: 'Campaign Landing Page request: <content info>'
labels: Needs refining, Public Websites, VA.gov frontend, User support, CLP, sitewide
assignees: jilladams, FranECross
labels: Needs refining, Public Websites, sitewide, User support, VA.gov frontend
assignees: FranECross, jilladams

---

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/pw-forms-bad-pdf-link-pw.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "(PW) Forms/Bad PDF link defect"
about: Forms outages / Bad PDF links, owned by Public Websites team
title: 'Forms defect: <form name>'
labels: Defect, Find a form, Needs refining, Public Websites, sitewide
assignees: jilladams, FranECross
assignees: FranECross, jilladams

---

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/pw-injected-header-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "(PW) Injected Header/Footer - publish to prod"
about: Submit a request to publish the injected header/footer to prod.
title: 'Injected header/footer: Publish to prod: <domain(s)>'
labels: Injected header, Needs refining, Public Websites, VA.gov frontend, sitewide
labels: Injected header, Needs refining, Public Websites, sitewide, VA.gov frontend
assignees: jilladams

---
Expand All @@ -19,4 +19,4 @@ This ticket adds new domain(s) to allowlists that gate the injected header. When
## Acceptance Criteria
- [ ] Devops PRs to add www & non-www domain(s) have merged
- [ ] Requesting team has signed off that they're ready to publish
- [ ] On requested domain(s) the global header is injected on page load, with no cookie updates required
- [ ] On requested domain(s) the global header is injected on page load, with no cookie updates required
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/pw-injected-header.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "(PW) Injected Header/Footer - prep for testing"
about: Submit a request to add the injected header/footer an existing site.
title: 'Injected header/footer: <domain(s)>'
labels: Injected header, Needs refining, Public Websites, VA.gov frontend, sitewide
labels: Injected header, Needs refining, Public Websites, sitewide, VA.gov frontend
assignees: jilladams

---
Expand Down
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/qa-incidental.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ _Semi-frequently (at least a few times per sprint), read through the production
| Date | Issue(s) |
| ---- | -------- |
| | |

2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/research-collab-cycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Collaboration Cycle Research touchpoint(s) for [PRODUCT/INITIATIVE]
about: Use this template when you have a research plan & conversation guide ready
for review by other teams
title: Get through Collaboration Cycle before user research starts
labels: UX, Research
labels: Research, UX
assignees: ''

---
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/research-conversation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Research Conversation Guide
about: Use this template when you are drafting a conversation guide
title: Draft [PRODUCT/INITIATIVE] conversation guide
labels: UX, Research
labels: Research, UX
assignees: ''

---
Expand Down
Loading

0 comments on commit bd28f7d

Please sign in to comment.