Skip to content
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

Adding comments in a review should be accessible #1930

Closed
2 tasks done
alexr00 opened this issue Jun 24, 2020 · 6 comments
Closed
2 tasks done

Adding comments in a review should be accessible #1930

alexr00 opened this issue Jun 24, 2020 · 6 comments

Comments

@alexr00
Copy link
Member

alexr00 commented Jun 24, 2020

  • There should be some screen reader feedback that a line can have a comment added, accessible with mouse and with keyboard.
  • There should be a way to add a comment with the keyboard.
@daniel-montalvo
Copy link

Any progress on this? At least having an action that the user can then bind to their keystroke of choice would be very much appreciated. Of course the ideal situation is that these actions would be already pre-configured with dedicated keystrokes.

@alex19EP
Copy link

hello. do you plan to work on this? since I cannot leave multi-line comments through the github interface, I would like to do this at least through vsCode.

@RMacfarlane
Copy link
Contributor

There is a workbench.action.addComment command that can be used for starting a comment, but it doesn't have a keybinding by default, so is extremely undiscoverable. There is also workbench.action.submitComment which is bound to ctrl/cmd + enter by default

The screen reader feedback about which lines are commentable is missing

@webdog
Copy link

webdog commented Jun 1, 2022

There is a workbench.action.addComment command that can be used for starting a comment, but it doesn't have a keybinding by default, so is extremely undiscoverable.

Oh wow, thank you for this comment <3. I was pulling my hair out for the last half hour trying to figure out what I was doing wrong.

What @RMacfarlane is mentioning is what I am understanding as leaving a Pull Request comment, which is an idiom I've understood for quite some time: In a PR, in the files changed tab, the + and - icons, when clicked trigger a form box to leave comments. I'd consider this to be the etymology of the concept, backed up by this doc:

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request

In VSCode/github.dev, when I pull up the keyboard shortcuts and search for "Pull Request Comment" I have the following returned:

image

"GitHub Pull Requests: Add Comment" -- Without any additional context, I am guessing this is what I want to do: I am in a PR, and I want to leave a comment on a line. Whether it's in a conversation or in a file is a context switch that I haven't anticipated. In actuality, this is to leave a PR comment in the PR conversation, which is a view that didn't load by default for me on github.dev.

Triggering the shortcut returns an empty javascript error and the console logs nothing of use to breadcrumb me towards where the element the keyboard shortcut is triggering.

image

The JS console is less helpful. Chrome reports that this shortcut trigger is some sort of violation of a touchstart event:
image

Next search, let's look for "Line Comment":

image

Oooh, here we go. This is promising. And logically makes sense to my 🧠 . The docs say "Line Comment" and these are also "Line Comments." When I open the PR diff, I'm in an editor, so this looks like it could be right.

Incorrect. This time, github.dev/VSCode reports this shortcut is simply unknown, and because the error has been handled, the console doesn't report any additional information that could help.

image

30 minutes of struggling with github.dev and searching the web, I come across this thread, and the solution against an unresolved issue.

Side note: I couldn't find a repository for github.dev issues. SInce this extension is built directly into github.dev it wasn't clear if I needed to open an issue against the customized vscode instance that is github.dev, or this repo, which I found through happenstance.

@alexr00
Copy link
Member Author

alexr00 commented Jun 2, 2022

We're still lacking screen reader feedback that a comment can be added on the current line, but other accessibility updates were added a few months ago: https://code.visualstudio.com/updates/v1_66#_comment-accessibility-improvements

@alexr00 alexr00 self-assigned this Sep 7, 2023
@alexr00 alexr00 added this to the September 2023 milestone Sep 7, 2023
@alexr00 alexr00 closed this as completed Sep 20, 2023
@alexr00
Copy link
Member Author

alexr00 commented Sep 20, 2023

When an editor is opened we now give an aria status that the editor has commenting ranges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants