Steps to new PR comment 100% release (per Q3 2023)

[codecovdesign]

Epic outlines steps toward release of new comment, as per the Q3 review

Problem to solve:

We get a lot of feedback that Codecov is noisy/not showing what’s important in both the PR comment and PR page in app. This epic is specifically relevant to the PR comment and the issue of all files being in the same table together, whether you touched them in your PR or not. We’re also looking to move the most important info to the top of the comment (clearly labeled patch and project coverage) as well as ameliorate the lack of indicators around removed code behavior.

Updating the PR comment:

highlight patch and include project coverage up top.

Include line to indicate when removed code behavior comes into play

Put indirect coverage changes minimized in its own section to highlight git diff files first and foremost

Improve routing to land on the specific file in the app that was clicked in the PR Comment

Solution direction and planning

• layout prioritizing patch
  • block quote with data source and project change
  • small copy change removing by with :
• showing changed files separate from unexpected indirect changes
  • meets user expectations of "I change X files", previously from "why do I see Y amount?"
  • aligns to information architecture seen in upcoming pulls page
  • reduces cognitive load
• improves links routing user expects
  • specific file => lands on file expanded in pulls page
  • indirect changed files => lands on respective section in pulls page

Applications team

1. Link to PR page expands code chunk #295
   • follow up / in tandem w/ platform team: Linking pr to code chunk #122
2. Make PR comment and in-app consistent data (show coverable files that changed) #286

Other / pre-release

1. Update pull request documentation images/copy to reflect new comment format #283
2. New PR comment release blog #284
3. New PR comment QA review #285
   • challenging to see in production

platform team related issues

• Anchor components/flags directly to sections in-app #8
• Align copy in PR comment to app section (+ other copy updates) #9
• Remove project coverage from summary line #123
  • Feedback solicitation applications-team#43
• Linking pr to code chunk #122
  • blocked by: Link to PR page expands code chunk #295

[gambreu]

@codecovdesign could you possibly edit the initial comment here to include the documentation you did in the Jira issue (i.e. "Problem to solve", "Design/Solutions", etc): https://codecovio.atlassian.net/browse/CODE-2555

Just want to keep all information in a centralized data location. Thank you!

[codecovdesign]

@gambreu updated ✅

[rohan-at-sentry]

@codecovdesign can you update the description with this task that captures the work to support the new design iteration?

#446

[codecovdesign]

closing epic as all new changes have been made, captured and/or will be completed