Skip to content

Group identical code quality issues in full code quality report by file

Based on an actionable insight from the UX Department: MRs experience async critique research (insight) we want to apply the same improvements to the full code quality report.

What

In the code quality report, there is a lot of item duplication. There is no information hierarchy or typography differences.

image

Why

With so much duplicated content, it's difficult to focus on what makes each issue different. It also makes it hard to ignore a specific group of similar/identical issues.

How

Items should be sorted by severity and then grouped by the file they were found in so that it's easier to parse the list for common issues that can be resolved.

No additional UI will be done in this iteration just a list sorted by severity and then grouped by file name (sort those alphabetically so all the critical violations in a.js then in b.js, etc. then the Major violations in a.js then in b.js, etc. etc.)

This will result in the same file being listed multiple times if there are violations found that are Major and Minor for example but it ensures the most critical issues are presented first and grouped logically.

This implementation should also work better once users can filter lower level violations from the UI.

Edited by James Heimbuck