Skip to content

[chore] Fix broken markdownlint anchor link in CONTRIBUTING.md#5154

Merged
reyang merged 1 commit into
open-telemetry:mainfrom
cijothomas:cijothomas/fix-markdownlint-link
Jun 15, 2026
Merged

[chore] Fix broken markdownlint anchor link in CONTRIBUTING.md#5154
reyang merged 1 commit into
open-telemetry:mainfrom
cijothomas:cijothomas/fix-markdownlint-link

Conversation

@cijothomas

@cijothomas cijothomas commented Jun 14, 2026

Copy link
Copy Markdown
Member

The link https://github.com/DavidAnson/markdownlint#optionsresultversion in CONTRIBUTING.md is broken — the options.resultVersion section was removed from the upstream README in markdownlint v0.41.0 (2026-06-08), so the anchor no longer resolves. This is the only failure in the markdown-link-check CI job.

Replacing it with https://github.com/igorshubovych/markdownlint-cli#fixing-issues, which is a better target for two reasons:

  1. It points at the --fix flag documentation, which is what "fix markdownlint violations" actually means for a CLI user. The original anchor pointed at result-format versioning, unrelated to fixing.
  2. markdownlint-cli is the tool OTel actually invokes via make markdownlint (declared in package.json and called from the Makefile). DavidAnson/markdownlint is the underlying Node library; contributors don't interact with it directly.

@cijothomas
cijothomas requested a review from a team as a code owner June 14, 2026 18:01
@cijothomas
cijothomas force-pushed the cijothomas/fix-markdownlint-link branch from 36724f3 to 53edb54 Compare June 14, 2026 18:05
@cijothomas
cijothomas marked this pull request as draft June 14, 2026 18:06
@cijothomas
cijothomas marked this pull request as ready for review June 15, 2026 15:24
@reyang
reyang enabled auto-merge June 15, 2026 16:11
@reyang
reyang added this pull request to the merge queue Jun 15, 2026
Merged via the queue into open-telemetry:main with commit 2cc7d9f Jun 15, 2026
12 checks passed
@cijothomas
cijothomas deleted the cijothomas/fix-markdownlint-link branch June 15, 2026 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants