bcgov / cas-registration

A web app for Registration in OBPS under the Clean Growth branch
Apache License 2.0
1 stars 1 forks source link

Front end cleanup #1183

Open BCerki opened 6 months ago

BCerki commented 6 months ago

Description of the Tech Debt

Will have lots of conflicts with #1385 and @joshgamache 's file-moving PR

The Next App router creates makes files routable when they're called route.tsx or page.tsx (https://nextjs.org/docs/app/building-your-application/routing/pages-and-layouts).

Our app has a folder called routes and files called Page.tsx (note the capital) which are not routable, but because the names are so similar to what Next uses, there can be confusion. (Also, older versions of Next used a folder called pages to create routes, so there's a lot of opportunity for naming confusion.)

Suggestions to improve front-end clarity:

For the industry_user roles (files in app/(authenticated)/bceidbusiness):

For the cas roles (files in app/(authenticated)/idir):

Tech Debt Triage

The purpose of our technical debt triage process is to analyze technical debt to determine risk level of the technical debt and the value in tackling that technical debt.

Risk Value Scoring:

Level Value
High 3
Medium 2
Low 1
Technical Debt - Risk Types Level Value
Business Area Risk - Risk of business area visibility / damage to user experience
Developer Fault Risk - How likely will this tech debt cause a future error related to coding on top of it
System Fault Risk - Risk of system errors or application downtime
Time Scale Risk - Compound risk effect if left alone. How much more difficult to fix or dangerous will this become over time?
Time Sink Risk - How much will this tech debt slow the development process down
TOTAL SCORE:
marcellmueller commented 6 months ago

One minor thing I noticed we could clean up is rename OperationsForm to OperationForm to keep consistent with the rest of our application ie: Operations for a dashboard with a list of operations, Operation for a singular operation.

BCerki commented 5 months ago

This is blocked until after Thursday when Josh and Dylan's work goes in

BCerki commented 4 months ago

Much of the frontend will be refactored as part of part 2, so we probably don't need this anymore as discussed in sprint planning