renovatebot/renovate

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

已關閉

#30,312 建立於 2024年7月22日

 (4 則留言) (1 個反應) (1 位負責人)TypeScript (1,916 個分叉)batch import
help wantedpriority-4-low

倉庫指標

星標
 (14,066 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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

貢獻者指南