Skip to content

style: wrap bare URLs in CHANGELOG files (markdownlint MD034) - #12

Merged
fsans merged 1 commit into
developfrom
fix/changelog-bare-urls
Jul 2, 2026
Merged

fsans merged 1 commit into
developfrom
fix/changelog-bare-urls

Conversation

@fsans

@fsans fsans commented Jul 2, 2026

Copy link
Copy Markdown
Owner

Summary

Wrap the two bare URLs in each CHANGELOG file (Claris OData guide + reference implementation) in angle brackets to satisfy markdownlint MD034 (no-bare-urls).

The MD024 (no-duplicate-heading) warnings on the ### Added / ### Changed / ### Fixed sections are left as-is: those repeats are idiomatic for the Keep a Changelog format (each version section has its own Added/Changed/Fixed) and are a well-known false positive for that rule.

Follow-up to PR #10 which introduced the CHANGELOGs.

Test plan

  • No code changes — markdown only
  • pytest and npm run typecheck unaffected

Wrap the Claris OData guide and reference implementation URLs in angle
brackets in both CHANGELOG.md files to satisfy markdownlint MD034
(no-bare-urls). MD024 duplicate-heading warnings are left as-is: the
repeated Added/Changed/Fixed headings are idiomatic for the Keep a
Changelog format and a known false positive for that rule.
@fsans
fsans merged commit 5196e05 into develop Jul 2, 2026
5 checks passed
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.

1 participant