danielpalme / ReportGenerator

ReportGenerator converts coverage reports generated by coverlet, OpenCover, dotCover, Visual Studio, NCover, Cobertura, JaCoCo, Clover, gcov or lcov into human readable reports in various formats.
https://reportgenerator.io
Apache License 2.0
2.58k stars 281 forks source link

Red-green colorblind accessibility issue with coverage report #595

Closed kristinnbragi closed 1 year ago

kristinnbragi commented 1 year ago

I was going over code coverage results with a developer who has colour blindness and discovered that the tool is not accessible for red green colour blindness. Line highlights are especially hard to differentiate due to the desaturated colour. A natural fix would be to include symbols as a supplement.

Screenshot 2023-03-03 at 14 50 02
danielpalme commented 1 year ago

I totally understand that this is an issue.

kristinnbragi commented 1 year ago

Do you have a concrete idea for "include symbols as a supplement"?

Not really, although a simple + or - would work, it might also be misleading. Another tool, Bullseye, uses these icons for example:

Screenshot 2023-03-06 at 15 48 43

Would a different color scheme be more helpful (e.g. blue/yellow instead of green/red). What would be good colors?

Definitely! I don't know what colors would make sense that would support all types of color blindness. Ultimately, the best solution would be to offer the user to choose their own color scheme

danielpalme commented 1 year ago

I added a new report type Html_BlueRed in version 5.1.19 To use it, add the following command line parameter when executing ReportGenerator: -reporttypes:Html_BlueRed

Here you can find a sample report: https://reportgenerator.io/resources/reports/Html_BlueRed/index.html

Hope this helps!

vzhik54 commented 11 months ago

I added a new report type Html_BlueRed in version 5.1.19 To use it, add the following command line parameter when executing ReportGenerator: -reporttypes:Html_BlueRed

Here you can find a sample report: https://reportgenerator.io/resources/reports/Html_BlueRed/index.html

Hope this helps!

Hello. Could you please clarify what type of reports I can use for summary report to resolve the same trouble?

danielpalme commented 11 months ago

Hello. Could you please clarify what type of reports I can use for summary report to resolve the same trouble?

There no separate Blue_Red summary report yet. But I can add this in the next release.

vzhik54 commented 11 months ago

Thanks a lot

danielpalme commented 11 months ago

@vzhik54 I just created a sample report: https://reportgenerator.io/resources/reports/Html_BlueRed_Summary/summary.html

Does this work for you?

The next release will contain the new report type Html_BlueRed_Summary.

vzhik54 commented 11 months ago

@danielpalme Yes, this report type work for me. Thanks :-)

danielpalme commented 11 months ago

Release 5.1.26 is now available. It contains the new report type.