renovatebot/renovate

Replace bare links in `index.ts` files in the `modules/versioning/*/` pattern with good links

Open

#30312 opened on Jul 22, 2024

View on GitHub
 (4 comments) (1 reaction) (1 assignee)TypeScript (14,066 stars) (1,916 forks)batch import
help wantedpriority-4-low

Description

Describe the proposed change(s).

Replace bare links in index.ts files in the modules/versioning/*/ pattern with good links.

Bare links are hard to read, and especially bad for screen reader users. Add a descriptive name to each bare link.

Todos

  • Write failing test first
  • Update all urls constants
  • Open PR

Write failing test first

Scope of test: all urls constants in the pattern modules/versioning/*/index.ts.

Condition Test result
Any item in the urls array is not wrapped between []() characters. Fail
All items in the urls array are wrapped between []() characters. Pass

Update all urls constants

Example of a good link, that passes the test:

 export const urls = [ 
   '[Microsoft API versioning guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-versioning)', 
 ];

Open PR

You are ready to open a pull request when the test passes.

Related discussion/issue

I asked about fixing the bare links in this discussion:

  • #29483

Fixing the bare links is part of the work for:

  • #29148

Contributor guide

Tech stack
typescript
Domain
accessibilitytesting
Issue type
accessibility
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptFamiliarity with Renovate's module structureExperience with testing (Jest or Vitest)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Start by exploring the file pattern `modules/versioning/*/index.ts` in the Renovate repository. Write a failing test that asserts each item in the `urls` array is wrapped in Markdown link syntax `[]()`. Then update the `urls` constants to include descriptive link text as shown in the example. Reference discussion #29483 and parent issue #29148 for context. Ensure the test passes before opening a PR.