Solid analysis is not only meaningful and accurate, it’s also presented in a way that is easy to parse and highly actionable. As we add more types of quality and security checks (like the 19+ checks we recently added for PHP), finding the right way to lay out this data becomes both more challenging and more critical.
This is a topic we’ve been thinking a lot about recently. In doing so, we identified that the existing design of our Issues page fell short of ideal. While it did provide an exhaustive list of the repository’s flagged issues, it didn’t lay out the analysis in a way that was easy to parse, prioritize, and action.
Today we’re excited to announce an Issues page redesign aimed at improving how the data is presented and organized. Every flagged issue now lives in a category, allowing you to quickly see which types of issues have been flagged and how many issues there are for a particular type.
Clicking on a specific category shows you all issues of that type. From this page you can drill down into the details of each individual issue. For example, you can see the lines of code causing the issue (if applicable). In addition, you can click the “book” icon to get detailed documentation and refactoring help. Furthermore, if you want to quickly bounce to another issue type, you’ve got the sidebar on the right.
While your Feed page is aimed at visualizing how your codebase is changing over time (i.e,. getting better or worse with each commit), your Issues page displays every last issue we’ve flagged. While we don’t necessarily recommend combing through this exhaustive list and resolving every last one, it is helpful to identify what’s been flagged and what needs to be addressed. Our new design will hopefully make this process easier.
As always, we’ve love to hear your feedback.