Skip to content

chore(docs): apply Codacy markdownlint fixes#6284

Open
thomhurst wants to merge 1 commit into
mainfrom
chore/codacy-markdownlint-docs
Open

chore(docs): apply Codacy markdownlint fixes#6284
thomhurst wants to merge 1 commit into
mainfrom
chore/codacy-markdownlint-docs

Conversation

@thomhurst

@thomhurst thomhurst commented Jun 19, 2026

Copy link
Copy Markdown
Owner

Applies the Codacy code-quality patch across documentation and instruction files.

Rules applied

  • MD022 / MD032 — blank lines surrounding headings and lists (bulk of the diff)
  • MD034 — wrap bare URLs in angle brackets (copilot-instructions.md)
  • MD026 — strip trailing colons from some headings (requirements-start.md)

Scope

Docs / .claude / .github only — no source or runtime changes.

Notes (patch applied verbatim, including its inconsistencies)

  • CONTRIBUTING.md: dropped trailing period on the Legal Notice line (cosmetic, not a lint rule).
  • requirements-start.md: MD026 colon-strip applied to Full Workflow, Question Formats, Expert Questions (Phase 4), Metadata Structure but not Important Rules: / Phase Transitions: — Codacy was inconsistent. Expert Questions (Phase 4) had its colon stripped but no blank added before its code fence, so MD022 is still technically violated there.
  • Overlapping MD022+MD032 hunks were collapsed to a single blank line per gap (two blanks would trip MD012).
  • AnalyzerReleases.Shipped.md files are parsed by the RS2000 release-tracking analyzer; existing #### subheadings already build, and blank-line inserts are tolerated.

Apply Codacy code-quality patch across docs and instruction files:
- MD022/MD032: blank lines surrounding headings and lists
- MD034: wrap bare URLs in angle brackets (copilot-instructions.md)
- MD026: strip trailing colons from some headings (requirements-start.md)

Docs/.claude/.github only; no source or runtime changes.

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review: chore(docs): apply Codacy markdownlint fixes

This is a clean, purely mechanical documentation improvement. All changes are consistent and correct.

Summary

The PR applies markdownlint rules uniformly across all documentation and markdown files:

  1. Blank lines after headings — adds the required blank line between a heading and the following content, which improves rendering consistency across different markdown renderers.

  2. Blank lines before lists — ensures lists are preceded by a blank line, preventing some renderers from treating list items as inline text rather than list elements.

  3. Angle brackets for bare URLs in copilot-instructions.md (e.g. https://tunit.dev<https://tunit.dev>) — this is the correct markdownlint-compliant way to make bare URLs clickable in strict CommonMark mode.

  4. Removed trailing period from the CONTRIBUTING.md legal notice sentence — minor punctuation fix that also happens to be linter-required.

  5. Added missing newlines at end of files — several files were missing a terminal newline, which is a common linter requirement and a POSIX convention.

No concerns

  • No content changes — only whitespace, blank lines, and formatting.
  • All changes follow established markdownlint conventions.
  • The fixes are consistent across files.

This is good hygiene and safe to merge.

@codacy-production

Copy link
Copy Markdown

Not up to standards ⛔

🔴 Issues 2 minor

Alerts:
⚠ 2 issues (≤ 0 issues of at least minor severity)

Results:
2 new issues

Category Results
CodeStyle 2 minor

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

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