department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
279 stars 195 forks source link

Flag instances of custom error messages in forms as needing additional review #11358

Open meganhkelley opened 3 years ago

meganhkelley commented 3 years ago

User Story

As a VSP team member, I need to know when a VFS team is overriding the default forms error messaging, so that I can ensure the new messaging adheres to VA.gov best practices.

Definition of Done

meganhkelley commented 3 years ago

From Dan:

OVERALL_REVIEW_COMMENT: >

Custom error message found

    Please note that this error message would override the default forms library error message for this page.
    ## What you can do
    Custom error messages will require explicit approval from VSP content & design. This can be flagged during a regular collaboration cycle review or brought to #vfs-platform-support.
  LINE_COMMENT: review page custom error message found
rianfowler commented 3 years ago

Does this flag need to be a blocking approval? I don't think the flag for manual review feature supports this yet.

meganhkelley commented 3 years ago

Per decision documented here: https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/products/platform/automated_code_quality/08-31-20-manual-review-trigger-decision.md

We are not going to add a manual review trigger ("review bot") for custom form submission error messages.

meganhkelley commented 3 years ago

@peggygannon please note the above link & context. tl/dr: we were going to add a "review bot" (a flag when someone submitted a PR) to highlight instances where an app team was using a custom form submission error message in the form, instead of the hard coded error messages. We are not adding that review bot for the time being. Our expectation is that custom form submission error messages will be reviewed as part of typical content review in the Collaboration Cycle.

Let me know if you have Qs, and please tag other folks who need to know about this decision as needed! Thanks