Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.36 KB

ISSUE_TEMPLATE.md

File metadata and controls

60 lines (36 loc) · 2.36 KB

What 👋

A quick description outlining the context of this issue.

Example:

Improve the current login widget form validation.

Where 🔍

An overview of "avenues" that are influenced/affected by this request.

Example:

  • This relates to the larger #123 WCAG 2 AA compliance issue.
  • The login widget can be found on the core /login screen.

Why 🤔

Dispel any ambiguity around why this issue needs a resolution.

Example:

It has become a core requirement to the business that our high traffic pages get immediate treatment from an accessibility perspective. This is to ensure that we comply with the WCAG 2 AA specifications and maintain our compliance rating.

Currently our login widget is falling short of an optimal user experience and needs urgent attention given its significance to our application.

How 💡

Ideas/leads/breadcrumbs around how to proceed with resolving the issue.

Example:

  • @jared has put together a validation flow in which will act as a reference during the development phase. new-design

  • @sarah is the project owner for the login widget and can help from a timing perspective.

  • @tim has recently added redux-form to then sign up page and says that it will be helpful in this scenario too.

Note 📋

Any information that does not fit into the above categories giving extra context to the issue.

Example:

It would be nice at some stage to pull these validation "patterns" out into their own global reference for everyone to use. In that regard, we can make a subsequent issue that leverages this work as part of a refactor.

Demo 📺

Bring clarity to the issue with visual aids:

  • Screenshots: cmd + shift + 4 (MacOS).
  • Gifs: GIPHY Capture (free/MacOS).
  • Code Snippets: Carbon (free).

Example:

Validation message appears at the bottom of the widget and has no affiliation to the inputs that need addressing. The messaging is also ambiguous and offers no context to the user.

form-before