Allow PR reviewers to comment on and suggest changes to unedited lines of code

[dotproto]

One of my favorite changes to GitHub's PR review experience was the introduction of suggested changes. I regularly use this feature in documentation PRs; suggesting changes really helps speed up the review cycle by allowing me to prepare a necessary change and allowing the PR creator to review and accept it rather than me commenting how we should modify the text.

A major drawback to the current implementation, though, is that the GitHub UI does not allow reviewers to suggest changes to lines that are not directly affected by the PR.

Hovering over a line in right next to changed lines gives an 'add line comment' button

Hovering over a line that was hidden behind the "Expand up" or "Expand down" buttons does not display an 'add line comment' button

Please allow reviewers to comment on and suggest changes to any line in the files under review.

July 14, 2023 update: Unmarked @willsmythe's comment as an answer to this request as github/roadmap#347 is still open and on the backlog.

[Arcanorum]

Relevant. isaacs/github#1655

[talesa]

Same from 2014: isaacs/github#284

Seriously, today I've just googled it again thinking to myself "maybe I'm just dumb and I don't know how to do it", just to rediscover all of those threads from 2014, and it turns out my past self went through the same process at some point because I've already upvoted all of them 😅

So here we go again

[davisking]

Yeah, hardly a day goes by that I don't want to comment on some line but the GitHub UI is like "nope, if you want to talk about that line go write out in English author, please look at line 123 and pretend what I'm saying here was written there and stick it on an unrelated but edited line :)

[ChJones-IDM]

How is this not a thing already? GitHub PRs are by far the worst code review tool I've ever used. This would make it a tiny bit better.

[ayyadalaa]

I just needed this feature today, I wanted to point out something that is related to the change but not part of it.

[star-square]

I also needed this feature today in order to comment on some code not changed by the PR but relevant to the PR's changes.

[codesnik]

I'd think that it's a problem to do because code suggestions need to be retained, even as "outdated", even after PR author pushes more commits or even rebases and force-pushes the branch. Probably comments are linked to specific lines in the unified patch of the PR.
But code suggestions outside of the main patch still could work the same, by keeping separate patch layer for suggestions.

[ajilani]

But it does allow you to comment on code that is near the changed code, up to 3 lines away. This seems to me like an arbitrary choice. The functionality appears to already exist for commenting on code that was not changed by the PR. Or are those nearby lines included in the patch file? In that case, I could understand why this is not trivial to implement.

[jdmaguire]

That's my assumption. We're all developers. If something like this isn't already implemented, we can assume there was some structural choice made deep in GH codebase that makes this non-trivial to add in an efficient way.

[Simran-B]

up to 3 lines away. This seems to me like an arbitrary choice

3 lines is exactly the standard amount of context lines in unified diffs. Doesn't seem arbitrary to me.

[TheGiraffe3]

What if you could set a line count somewhere in the .github file?

[whenmoon]

Completely bizarre that this is not possible. Case in point: a PR refactors a file from JS to TS. If a line has not been refactored and therefore changed, how do I point it out to the dev??

[Salimibut]

GitHub public roadmap

[willsmythe]

Thanks for the feedback. We understand the need and are investigating the feasibility this quarter. 2021-12-19 update: Commenting on any line of a file changed in the pull request is on the roadmap for next quarter: github/roadmap#347. Please use #9099 to discuss commenting on unchanged files.

[muescha]

@chriskuech see "Answer selected by @michellemerrill"

[cyjohnson-ss]

Just started using this, and felt the same need. Thought it would be implemented by now, as this is a couple of year old. OMG

[StingyJack]

Commenting on any line of a file changed in the pull request is on the roadmap for next quarter:

@willsmythe - That was for over a year ago. Is this feature that can prevent defects and improve quality really more important than roadmap items like these (from the roadmap)
github/roadmap#528
github/roadmap#355
github/roadmap#536 - especially this one since its pretty much the same kind of thing

[hyperTwitch]

@willsmythe I see github/roadmap#347 has been closed out. How can we follow along on if/when this will be revived on the roadmap? Looking for something I can follow in order to see when the work gets picked up and when it might be available.

[modernai390]

++

[LittleHuman1]

One of my favorite changes to GitHub's PR review experience was the introduction of suggested changes. I regularly use this feature in documentation PRs; suggesting changes really helps speed up the review cycle by allowing me to prepare a necessary change and allowing the PR creator to review and accept it rather than me commenting how we should modify the text.

A major drawback to the current implementation, though, is that the GitHub UI does not allow reviewers to suggest changes to lines that are not directly affected by the PR.

Hovering over a line in right next to changed lines gives an 'add line comment' button
valid

Hovering over a line that was hidden behind the "Expand up" or "Expand down" buttons does not display an 'add line comment' button
invalid

Please allow reviewers to comment on and suggest changes to any line in the files under review.

Replies
9 suggested answers
·
8 replies

Arcanorum
on Jul 8
Relevant. isaacs/github#1655

image

0 replies
@LittleHuman1 Write a reply

davisking
on Jul 17
Yeah, hardly a day goes by that I don't want to comment on some line but the GitHub UI is like "nope, if you want to talk about that line go write out in English author, please look at line 123 and pretend what I'm saying here was written there and stick it on an unrelated but edited line :)

0 replies
@LittleHuman1 Write a reply

ChJones-IDM
on Sep 8
How is this not a thing already? GitHub PRs are by far the worst code review tool I've ever used. This would make it a tiny bit better.

0 replies
@LittleHuman1 Write a reply

ayyadalaa
on Oct 2
I just needed this feature today, I wanted to point out something that is related to the change but not part of it.

0 replies
@LittleHuman1 Write a reply

star-square
on Oct 2
I also needed this feature today in order to comment on some code not changed by the PR but relevant to the PR's changes.

0 replies
@LittleHuman1 Write a reply

codesnik
on Oct 7
I'd think that it's a problem to do because code suggestions need to be retained, even as "outdated", even after PR author pushes more commits or even rebases and force-pushes the branch. Probably comments are linked to specific lines in the unified patch of the PR.
But code suggestions outside of the main patch still could work the same, by keeping separate patch layer for suggestions.

0 replies
@LittleHuman1 Write a reply

whenmoon
on Oct 13
Completely bizarre that this is not possible. Case in point: a PR refactors a file from JS to TS. If a line has not been refactored and therefore changed, how do I point it out to the dev??

0 replies
@LittleHuman1 Write a reply

willsmythe
on Oct 14
Thanks for the feedback. We understand the need and are investigating the feasibility this quarter. 2021-12-19 update: Commenting on any line of a file changed in the pull request is on the roadmap for next quarter: github/roadmap#347. Please use #9099 to discuss commenting on unchanged files.

8 replies
@CyberFlameGO
CyberFlameGO
on Nov 16
Yeah, that’d mean less people having to make PRs that supersede an already-PR’d change/make PRs to a non—upstream fork (both workarounds are messy) which then has to get merged into the fork (contextually I’m primarily talking about the unmodified files thing, but also the lines thing)

@swythan
swythan
on Nov 25
Another use case that just came up at my company is PR review bots. At the moment if they annotate lines that weren't changed in the PR, then the annotations aren't visible.

Think "Security Linter" where one config change might cause another part of the configuration to become invalid (or to need a warning about the possibly unexpected cascaded change).

@willsmythe
willsmythe
7 days ago
FYI. Commenting on any line of a file changed in the pull request is on the roadmap for next quarter: github/roadmap#347

I created a new discussion specifically about commenting on unchanged files: #9099. Please add any additional comments there (and upvote if this is something you need).

@swythan - can you create a new discussion for your request about review bots and annotations? It wasn't clear if you were asking that unmodified, annotated files just be visible in the Files Changed tab, or for also allowing users to comment on them.

@swythan
swythan
6 days ago
@willsmythe I guess I was assuming that the annotations the bot was making were in some way equivalent to user comments.

I'll forward this to the team that was trying to do this.

@AndrewMonteith
AndrewMonteith
6 days ago
Hi @willsmythe - I've started a discussion for the annotation use case: #9144
Thanks @swythan for altering me to this discussion

@LittleHuman1 Write a reply
Answer selected by michellemerrill

[schollii]

How can we tell the progress of github/roadmap#347, since Q1 is over and it is not possible still, just wondering if there is status somewhere, has it been started or not, almost done, done but waiting for official release, etc.

[inerognes]

Looks like the status is Q4 2022 – Oct-Dec

[db410009]

This is nice!!

But the rational at github/roadmap#347 is also applicable to not modified files
So... progressing what it is nice.
But... the gap (partially) still there

[TWiStErRob]

They moved it to "Future" milestone now, seems like AI has fully taken over, and DX is not as important now :(

[jeffsaremi]

Github is really disappointing compared to Gitlabs. And they're supposed to be the originators.

[StingyJack]

The credited originator of Git has unkind words for GitHub PR's/merges. I have different unkind words about the tooling and flow. That said, it could always be worse (and corrupt history every other week)

[Maher-Reven]

@jeffsaremi don't lose your hope on them man

[tiwaria1]

Upvoted. This would be incredibly useful.

[anurag-bug]

+1

[emmett2020]

Any progress on this?

[cdodrzywolski]

Yes Please!

When PRing a file that was updated, it would be so much nicer to just say oh hey you forgot to update this line too.

[kfchou]

2000 upvotes later... any progress updates would be appreciated!

[tapz]

Github is owned by Microsoft. So, do not expect too much.

[Gillysuit]

Github, I will name one of my cats Octocat if you add this, please 🐙

[BenROhio]

Commenting from February 2025 when this feature still hasn't been implemented. Come on github. You can do it.

[micmartin-x]

Basic feature missing!

[peytontucker]

I have needed to provide suggestions on unchanged lines several times (including just now)... but have to opt for the less-specific file-level comment. This feature would be very, very appreciated!

[andrecarlucci]

I just found myself needing this feature for the 1000th time today :)

[BenROhio]

Between this issue and the original it looks like this problem has over 3000 upvotes, making it the top thing your customers want solved.

[mgu-voyado]

I just did a review where this ended up being an issue multiple times. It's so frustrating to not be able to provide proper feedback when the line I want to comment on is right there, but just out of reach!

Sorry for venting my frustration. :)

[yashwant-raut]

FWIW, here’s a simple hack I follow:

I select multiple lines in the file (even if they are not part of the current PR). When you select lines, the URL in the browser updates to include the selected line numbers. If you copy this URL and open it in another tab, you'll see the selected lines highlighted.
This way, when you share the link with someone (for example, while reviewing a PR), they will see the same lines highlighted.

You can copy this URL and put in comment section of that particular file.

[BinhPQ2]

FWIW, here’s a simple hack I follow:

I select multiple lines in the file (even if they are not part of the current PR). When you select lines, the URL in the browser updates to include the selected line numbers. If you copy this URL and open it in another tab, you'll see the selected lines highlighted. This way, when you share the link with someone (for example, while reviewing a PR), they will see the same lines highlighted.

You can copy this URL and put in comment section of that particular file.

Yep was about to make the same comment but I'm glad I'm not the only one notices.

[cameronraysmith]

This is an important issue that many including myself have been thinking about for quite a long time.

Today I came across a conflict that made me ask the following question:

In what scenarios is the motivation behind the request for this feature not addressed by simply stacking another PR onto the source branch of the PR you're reviewing (even if it's an open source project and you're actually stacking that PR from your fork onto another third-party fork)?

The PR OP can then either merge your stacked PR, cherry-pick, or whatever else they want but you both get a proper patch diff and you can of course edit anything in the stacked branch and then (perma)link to the proposed changes in your review comments. Apologies if this has already been proposed above and I missed it.

[mathstuf]

While possible, this is so far removed from the normal code review process to be a really viable thing for (what I would consider) normal workflows.

Problems that make it high friction (non-exhaustive):

• another tab or terminal session (where the PR as-is needs fetched as well)
• no "pause and come back to it later" context is readily available as it is with reviews

Maybe a button to "suggest changes" that opens up the PR's source tree as a (potential) branch on your own fork would simplify things, but all in service of a workaround to leave a single comment? Doesn't seem worth the extra effort on Github's side to me compared to the core request here.

[BenROhio]

Also, in the workflows I deal with PRs have to be justified and the code is owned by certain people. So a new PR means I am making changes rather than the person who was working on the original issue, and this new PR has to be attached to a tracked work item. All I really want to do it mention to the person making changes already that they should be making (or considering) another related change on a line they haven't already touched.

[james-johnston-thumbtack]

Yet another missing GitHub feature in the core code review product that Gerrit has long supported for over a decade.

[georgepearman]

+1, ReviewBoard has this feature, its very useful