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
283 stars 205 forks source link

Explore raising code quality bar for VFS teams #50711

Open raywangoctova opened 1 year ago

raywangoctova commented 1 year ago

LOE

Small

Problem Statement

Currently, Platform has very little governance on the quality of code that VFS teams are putting in production. There are code reviews, but no overarching governance (like collaboration cycle) for a VFS product that ensures not just that the product works but that a bar for code quality is met.

User Impact

This leads to mediocre code written and pushed to prod by VFS teams

Where was this problem reported?

OCTODE Leadership reported this issue in the onsite but I'm not sure what the veteran or VFS user impact is.

What do we not know about the problem space?

Not much

What (if any) research or discovery has been done?

None

What is the acceptance criteria?

How should we measure success?

This has no success measurements because it is just suggesting possible paths forward for handling code quality based on industry standards and our current touch points with VFS teams.

TODOs

mchelen-gov commented 1 year ago

Currently this mostly consists of automated checks for code style (linting) and manual PR review. An ideal solution would consist of: 1) More in depth automated code quality checks (i.e. codeclimate) 2) Manual review for high impact code or as exception to automated checks