-
Notifications
You must be signed in to change notification settings - Fork 8k
Screen reader updates #7307
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
Screen reader updates #7307
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @chrstnb, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly enhances the accessibility of the command-line interface, particularly for screen reader users. It involves upgrading the core ink
UI library to its latest version, refining the logic for screen reader detection, and implementing specific rendering improvements. Key changes include replacing visual loading spinners with textual indicators and providing a structured, screen-reader friendly output for code diffs. Additionally, various UI components have been updated with appropriate ARIA attributes to improve their semantic representation for assistive technologies. This work aims to make the CLI more inclusive and usable for individuals with visual impairments.
Highlights
- Ink Dependency Upgrade: The
ink
dependency has been upgraded to version 6.2.3, which includes a fix for a bug related to screen reader support. - Screen Reader Flag Logic: The logic for determining whether the screen reader is enabled has been refined. If the
screenReader
command-line argument is not explicitly set, the system will now defer to the accessibility setting configured in the user's settings. - Accessible Loading Indicators: Visual loading spinners have been replaced with screen-reader friendly text indicators ("loading" or "responding") when a screen reader is detected, ensuring better accessibility during asynchronous operations.
- Screen Reader Friendly Diff Rendering: A new rendering mode for diffs has been implemented specifically for screen readers. Instead of visual formatting, diffs are now presented as a list of lines, each prefixed with its change type (e.g., "add:", "del:", "context:"), making them more understandable for users relying on screen readers.
- Constants Refactoring: Constants related to screen reader prefixes and loading states have been refactored into a dedicated
textConstants.ts
file, improving code organization and maintainability. - Enhanced ARIA Attributes for Accessibility: ARIA attributes (
aria-label
,aria-hidden
,aria-state
) have been added to various UI components, including tool status indicators and radio button selections, to enhance their semantic meaning and improve the experience for screen reader users.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces several valuable updates to improve screen reader accessibility, such as upgrading the ink
dependency, replacing visual spinners with descriptive text, and providing a screen-reader-friendly format for diffs. These are excellent changes for accessibility. However, I've identified a critical logic issue in how the screen reader configuration is determined, which could lead to incorrect behavior. My review includes a specific comment and a suggested fix for this issue.
Code Coverage Summary
CLI Package - Full Text Report
Core Package - Full Text Report
For detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved once these comments are addressed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TLDR
Dive Deeper
Example updated output:
Reviewer Test Plan
Testing Matrix
Linked issues / bugs