Improve support email formatting in README.md#29
Open
nirholas wants to merge 1 commit intoxai-org:mainfrom
Open
Improve support email formatting in README.md#29nirholas wants to merge 1 commit intoxai-org:mainfrom
nirholas wants to merge 1 commit intoxai-org:mainfrom
Conversation
Update the Contributing section in README.md to use a clickable Markdown link for the support email, improving accessibility, clarity, and usability without changing major content.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR addresses an accessibility and usability enhancement in the README.md file for the xai-proto repository. Specifically, it converts the reference to the support email in the Contributing section.
Motivation
This change makes the email address to be read by accessibility tools and users to know they will be clicking an email mailto in rendered Markdown views (e.g., on GitHub), enhancing the developer experience while preserving the original wording and intent. No functional or breaking changes are introduced.
As noted in the repository's improvement suggestions, hyperlinking the email improves navigation and accessibility for contributors.
Testing
Verified the link renders correctly on GitHub. Ensured no other parts of the README are affected.