Show project diff in the PR comment summary

codecov / engineering-team

This is a general repo to use with GH Projects

1 stars 1 forks source link

Show project diff in the PR comment summary #2022

Open codecovdesign opened 2 months ago

codecovdesign commented 2 months ago

Problem to solve

Today, we show the project coverage in the summary (OSS and Pro plan); however, we don't show the project change -/+ in top level summary. see feedback:

Please default to have this open window open, or at least display the red/green diff in the main body! It used to be a lot better.

Solution

Include project change in summary (- or +)

caendesilva commented 2 months ago

Much better! I would actually consider adding just a small code block with the following single line, just to get the red/green diff, and put the added text there instead of in a code block

codecovdesign commented 2 months ago

@caendesilva you're thinking something like this?

the diff green can only show in the codeblock markdown. here is a slight alternative leveraging an emoji to help display (-/+)

let me know what you think! next will share with the wider team for review and prioritization

caendesilva commented 2 months ago

Yeah I think that green codeblock diff is great. The emoji is a fair compromise in case the design team wants to save on vertical space. But remember: This diff is probably one of the most important features of the PR comment summary, so I think it's allowed to take up all the space it needs to be actually useful at first glance. Thanks for the responsiveness on this!