Add meaningful link text rule to code-guidelines (doctrine content)

Open Beginner friendly
#11 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Domain
accessibility, documentation

Research direction

Start by locating the code-guidelines HTML section and its semantic elements guidance, then read the linked WCAG reference for the intended standard. Add an explicit rule explaining that link text should be meaningful without generic phrases such as "click here" or "read more"; the work is done when the new guidance is present in the appropriate section.

Written by the indexing model from the issue text.

Description

doctrine good first issue help wanted ready

Problem

CG has no explicit rule about HTML link text. "Click here" and "read more" are accessibility failures and naming failures — the same principle as ubiquitous language applied to anchor text.

Reference

https://www.wcag.com/blog/writing-meaningful-link-text/

Where it fits

HTML section of CG language rules, near semantic elements guidance.

Low priority — new rule addition, not a fix.

Dominant language
Shell
Stars
0
Forks
0
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from GarrettS/web-xp

All issues in GarrettS/web-xp

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.