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

[chore] Accessible links 1 #6049

Open
wants to merge 26 commits into
base: main
Choose a base branch
from

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Jan 23, 2025

The web isn't limited to people who read content with their eyes. Some users use screen readers and other accessibility agents and some people have other reasons for appreciating descriptive links. To that end, check-spelling/spell-check-this includes a rule:

Do not use (click) here links

For more information, see:

(?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\()

The changes included here are designed to help users who benefit from descriptive links

jsoref added 26 commits January 23, 2025 10:20
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
@jsoref jsoref requested a review from a team as a code owner January 23, 2025 15:45
@opentelemetrybot opentelemetrybot requested review from a team January 23, 2025 15:46
@opentelemetrybot opentelemetrybot requested review from codeboten and removed request for a team January 23, 2025 15:46
@jsoref jsoref mentioned this pull request Jan 23, 2025
@chalin chalin added blocked accessibility Adds accessibility improvements labels Jan 24, 2025
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Hi @jsoref : while we greatly appreciate your contributions, there's a lot to juggle these days. I've marked all of your Accessibility PRs as blocked, just as a reminder that we'll be going through these carefully and slowly as time permits.

Also as I mentioned in #6051 (review), avoid "See [link] for xyz". Instead prefer a the form: "For xyz, see [link]".

Thanks again for your contributions. Looking forward to reviewing when we can.

@svrnm
Copy link
Member

svrnm commented Jan 24, 2025

Hi @jsoref : while we greatly appreciate your contributions, there's a lot to juggle these days. I've marked all of your Accessibility PRs as blocked, just as a reminder that we'll be going through these carefully and slowly as time permits.

Also as I mentioned in #6051 (review), avoid "See [link] for xyz". Instead prefer a the form: "For xyz, see [link]".

Thanks again for your contributions. Looking forward to reviewing when we can.

Hey @jsoref, just to reinforce this message: we are happy about your eagerness to help, but since you provide those PRs as a testing ground for your tool, we would appreciated, if you would have raised an issue first and asked us if and how we do this on our terms. We can still do this, but I recommend that if you do the same for other OSS projects as well, you ask first, as this will increase your chance of having your PRs received positively and merged eventually

I am also saying that, because we had similar situations in the past where people tried out their tools on our repositories. So, we are especially wary if those tools have a commercial interest and they aim to list our project as "user" for their tool. Because of that:

  • please disclose to us, if your goal is purely to stay open source with your tool or if you have any plans to productize it.
  • please note, that we review your PRs as if you would have created them without any tooling and on merit. A merged PR does not mean that we endorse your tool and if you'd like to list our project as one where your tool was used, you need to ask for explicit permission.

@jsoref
Copy link
Contributor Author

jsoref commented Jan 24, 2025

I have absolutely no intention to monetize. It's used by a number of major projects.

My goal is simply to get rid of spelling errors and related things. Preferably for people to get rid of them without me so that when I visit a project I don't run into spelling errors in the first place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants