Skip to content

Redesigned report header #381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Redesigned report header #381

wants to merge 5 commits into from

Conversation

davidjgoss
Copy link
Contributor

@davidjgoss davidjgoss commented Apr 28, 2025

🤔 What's changed?

This PR changes the "report header" components to be more compact and better-styled.

  • Pass rate and status proportions are shown as a mini pie chart
  • OS, runtime and implementation metadata is shown as a compact set of icons with tooltips for details
  • CI and Git get their own blocks
  • Status filters are more visually distinctive and include counts
  • Statuses are listed in severity order

Before

image

After

image

⚡️ What's your motivation?

The previous header was not very space-efficient and not great aesthetically either. This new header conveys the same information in about half the height and a more cohesive style.

🏷️ What kind of change is this?

  • ⚡ New feature (non-breaking change which adds new behaviour)

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.

Copy link

netlify bot commented Apr 28, 2025

Deploy Preview for cucumber-react-preview ready!

Name Link
🔨 Latest commit 51d7ad0
🔍 Latest deploy log https://app.netlify.com/sites/cucumber-react-preview/deploys/6814fb5960cb6b0008fa4885
😎 Deploy Preview https://deploy-preview-381--cucumber-react-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mpkorstanje
Copy link
Contributor

mpkorstanje commented Apr 28, 2025

The compression of the search and header is great. Keep that.

But the names and version numbers for the OS, platform and implementation are quite useful. Especially if we don't have a logo for the exact software used. For example Req'n Roll on Mono on Alpine.

Additionally the cell headers add some noise. That could be compressed a bit more by communicating the meaning implicitly.

For example:

55% passed in 0.7 seconds, 55 years ago.
Github Actions on <git-ref>
<implementation> on <platform> on <os>

Not sure where to put the logos for the implementation, platform and os though.

@davidjgoss
Copy link
Contributor Author

davidjgoss commented Apr 28, 2025

But the names and version numbers for the OS, platform and implementation are quite useful. Especially if we don't have a logo for the exact software used. For example Req'n Roll on Mono on Alpine.

Yeah these are available as tooltips on each one but I did suspect that wouldn't be discoverable enough. I might play with an icon/button that pops up the full details. Or slot the text in some other way.

Additionally the cell headers add some noise. That could be compressed a bit more by communicating the meaning implicitly.

I did experiment with that but found the headers made things generally a bit easier on the eye and easier to read, plus the values tend to get longer and put constraints on horizontal space. I'll try some more though.

@mpkorstanje
Copy link
Contributor

Yeah these are available as tooltips on each one but I did suspect that wouldn't be discoverable enough. I might play with an icon/button that pops up the full details. Or slot the text in some other way.

That would be useful. Being able to copy-paste diagnostics like that is really nice.

@davidjgoss
Copy link
Contributor Author

After a few iterations based on the feedback:

image

@davidjgoss davidjgoss marked this pull request as ready for review May 2, 2025 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants