Project setup

Project report

Verified against Soffi ·

The project report grades your app's code on two things, design system and accessibility, and turns what it finds into a short list of initiatives you can start in Soffi. Use it to see where the codebase stands, decide what to fix first, and watch the scores move as fixes merge.

Open the Project from Projects in the left rail and choose Report. Soffi generates the first report when the Project's code is imported. If a Project hasn't been graded yet, Generate report starts one.

The scores

Each domain gets a score out of 100, and the overview combines them into one overall score:

  • Design system measures drift from your own design system: hardcoded values where a token exists, and components built by hand where your design system already has one. It reads your actual tokens and components, so a project with no detectable design system says so rather than scoring zero.
  • Accessibility is scored against WCAG AA, and that's the number that counts toward the overall. AAA is scored separately as optional polish and never moves the overall.

The overview shows how far each score has moved since the first report. Each domain has a switch: turn one off and the overall re-averages the rest on the page, without changing the report.

How these scores were made explains each formula. Two of its caveats are worth knowing up front. The reviews sample the codebase and are model-driven, so scores move a few points between runs on identical code; read them as a direction, not a measurement. And severity drives the score, so read the finding counts beside each bar, not only the number.

Findings and initiatives

Under each domain, the report leads with Initiatives to kick off: findings grouped into pieces of work sized to take on as a unit. Each domain recommends up to three, and everything else sits under Other, so nothing is dropped. Behind them, What tripped the checks lists each check with its count and worst severity, and Individual findings lists every finding with its severity, file and line, and a suggested fix, so any claim can be checked in the source.

Start a Workspace from an initiative

Click Start on an initiative and Soffi creates a Workspace for it, with the initiative's prompt written into Soffi's message box. The prompt isn't sent: you land in the Workspace, read what Soffi is about to do, and send it when you're ready. The card's More actions menu shows the full prompt and lets you copy it.

The button tracks the work. Once started, it opens that Workspace. Once the pull request merges, the initiative shows as complete with a link to the pull request, and moves to Completed initiatives. While the Project is still deploying, initiatives can't be started yet, and the card says so.

Re-run and share

A report measures one commit. When initiatives merge after it ran, the report says how many and offers Re-run to see it, because the scores don't include that work yet. Re-run report does the same at any time.

Share copies a link to the report. Anyone in your Organization can open it, and it stays pinned to the run you shared, even after a re-run.

Editors, Admins and Owners can generate, re-run, and start initiatives. Anyone in the Organization can open a shared link.

Was this helpful?