Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.67 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

68 lines (43 loc) · 2.67 KB

What 👋

A quick description outlining the context of this pull request.

Example:

An update to the client-side validation system for the login widget.

Where 🔍

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

Example:

  • This resolves issue #123 and #456.
  • The login widget can be found on the core /login screen.
  • Leverages the redux-form implementation from pull request #789.
  • This validation enhancement will hide behind feature flag [LOGIN.VALIDATION].

Why 🤔

Dispel any ambiguity around why this bug/feature/enhancement was required.

Example:

Although the current validation system worked from a technical perspective, there were concerns round user accessibility (specifically message location and content) which would impact our WCAG 2 AA compliance rating.

How 💡

Background on the changes/choices made to fulfill this pull request.

Example:

  • redux-form has a built in validation system that fits our needs.
  • The integration requires that our form <input /> elements conform to the <Field /> abstraction (which I created a simple HOC to achieve).
  • redux-form creates its own entry (and format) in the redux "store" so there were several references in the application that needed to be updated to the new state schema.

Note 📋

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

Example:

We endeavor to move this validation pattern into our stand alone component architecture next sprint. The login widget is our initial test pilot (to validate our validation enhancements).

Demo 📺

Bring clarity to the code with visual aids:

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

If applicable, a before and after representation of your work is preferred.

Example:

Before 👎 🙁

Global invalidation message at the bottom of the form is visually discrete and uninformative.

form-before

After 👍 🙂

Individual invalid messages on a per/input basis. Message plus the <input /> itself has an error aesthetic.

form-after