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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

add GHPR accessibility help #5936

Merged
merged 3 commits into from Apr 22, 2024
Merged

add GHPR accessibility help #5936

merged 3 commits into from Apr 22, 2024

Conversation

meganrogge
Copy link
Contributor

fixes #5933

Once microsoft/vscode#210116 is merged shortly, we can adopt this here 馃槃 .

I am out tomorrow until Tuesday, so pls tweak and merge this.

I added most commands from the list JooYoung provided to the dialog. #5933 (comment)

@meganrogge meganrogge requested a review from alexr00 April 18, 2024 16:18
@meganrogge meganrogge self-assigned this Apr 18, 2024
@meganrogge meganrogge added this to the April 2024 milestone Apr 18, 2024
Copy link
Member

@alexr00 alexr00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments so you can see what I intend to change.

package.json Outdated
},
{
"id": "issues:github",
"name": "%view.issues.github.name%",
"when": "ReposManagerStateContext != NeedsAuthentication && !github:resolvingConflicts",
"icon": "$(issues)"
"icon": "$(issues>",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"icon": "$(issues>",
"icon": "$(issues)",

package.json Outdated
@@ -662,13 +663,15 @@
"id": "pr:github",
"name": "%view.pr.github.name%",
"when": "ReposManagerStateContext != NeedsAuthentication && !github:resolvingConflicts",
"icon": "$(git-pull-request)"
"icon": "$(git-pull-request)",
"accessibilityHelpContent": "Helpful commands include: \n-Refresh PR List <keybinding:pr.refreshList>\n-GitHub Pull Requests: Focus on Issues View <keybinding:issue.refresh> \n-GitHub Pull Requests: Focus on Pull Requests View <keybinding:pr:github.focus>\n-GitHub Issues: Copy GitHub Permalink <keybinding:issue.copyGithubPermalink>\n-GitHub Issues: Create an Issue <keybinding:issue.createIssue>\n-GitHub Pull Requests: Create Pull Request <keybinding:command:pr.create>\n-GitHub Pull Requests: Start Review <keybinding:pr.startReview>\n-GitHub Pull Requests: Mark Pull Request Ready For Review <keybinding:pr.readyForReview>\n-GitHub Pull Requests: Approve <keybinding:review.approve>"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These should both be localized.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, not all these commands support keybindings. The following should be removed:

  • GitHub Pull Requests: Mark Pull Request Ready For Review
  • GitHub Pull Requests: Start Review
  • GitHub Pull Requests: Approve

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the syntax for these supposed to be? I see this, which isn't a valid markdown link:

[Refresh issues](command:issue.refresh><keybinding:issue.refresh>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't look like this markdown and special keybinding syntax works. Here's what I tried:

Helpful commands include:\n-[Refresh PR List](command:pr.refreshList)<keybinding:pr.refreshList>\n-[Refresh issues](command:issue.refresh)<keybinding:issue.refresh>\n-[GitHub Pull Requests: Focus on Issues View](command:issues:github.focus)<keybinding:issue.refresh> \n-[GitHub Pull Requests: Focus on Pull Requests View](command:pr:github.focus)<keybinding:pr:github.focus>\n-[GitHub Issues: Copy GitHub Permalink](command:issue.copyGithubPermalink)<keybinding:issue.copyGithubPermalink>\n-[GitHub Issues: Create an Issue](command:issue.createIssue)<keybinding:issue.createIssue>\n-[GitHub Pull Requests: Create Pull Request](command:pr.create)<keybinding:command:pr.create>\n

And here's what it looked like:

image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll remove the markdown and keybinding syntax for now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that looks correct, there's an issue to improve upon this microsoft/vscode#210665

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks unfinished to me. Why do we show raw markdown in an end-user features?

package.json Outdated
@@ -29,7 +29,8 @@
"shareProvider",
"tabInputTextMerge",
"tokenInformation",
"treeViewMarkdownMessage"
"treeViewMarkdownMessage",
"contribAccessibilityHelpContent"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GHPR doesn't yet have permission to use this proposal.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enabled permission and alphabetized.

@alexr00 alexr00 enabled auto-merge (squash) April 22, 2024 10:06
@alexr00 alexr00 merged commit 33751f1 into main Apr 22, 2024
3 checks passed
@alexr00 alexr00 deleted the merogge/help2 branch April 22, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add GHPR accessibility help dialog
3 participants