chore(docs): apply Codacy markdownlint fixes#6284
Conversation
There was a problem hiding this comment.
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:
-
Blank lines after headings — adds the required blank line between a heading and the following content, which improves rendering consistency across different markdown renderers.
-
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.
-
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. -
Removed trailing period from the CONTRIBUTING.md legal notice sentence — minor punctuation fix that also happens to be linter-required.
-
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.
Not up to standards ⛔🔴 Issues
|
| Category | Results |
|---|---|
| CodeStyle | 1 minor |
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.
d7bed30 to
86ae2f2
Compare
There was a problem hiding this comment.
Code Review: chore(docs): apply Codacy markdownlint fixes
This PR is a purely mechanical documentation pass applying Codacy markdownlint rules (MD022/MD032 blank lines around headings/lists, MD034 bare URLs, MD026 trailing colon stripping) across 17 doc files. The bulk of the diff is correct and improves markdown consistency; no source or runtime code is touched. Two small issues worth addressing:
1. Missing EOF newlines left unfixed in two files
.claude/commands/requirements-current.md (line 72) and .claude/commands/requirements-status.md (line 42) both still end without a trailing newline — the diff shows \ No newline at end of file for both files even after this PR's changes. Several other files in this same PR did have their missing EOF newlines corrected (e.g. TUnit.Performance.Tests/README.md, tools/speed-comparison/BENCHMARKS.md), so these two appear to have been overlooked. Since EOF newlines are a standard POSIX/git expectation and linters typically flag them, they're worth adding for consistency with the rest of the fixes in this PR.
2. Unintended content change to legal notice text
.github/CONTRIBUTING.md line 44: the trailing period was removed from the Legal Notice sentence:
-> ### Legal Notice > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+> ### Legal Notice > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licenseThe PR description notes this as "cosmetic, not a lint rule," which is accurate — MD026 only strips colons from heading text, not periods from blockquote prose. This change wasn't required by any of the stated rules and modifies official legal wording unnecessarily. Suggest reverting the period.
Everything else looks correct. The inconsistencies in MD026 application on requirements-start.md (Important Rules: and Phase Transitions: still have colons) are acknowledged in the PR description, and since Codacy produced the patch verbatim, that's the right call to document rather than over-fix.
There was a problem hiding this comment.
Code Review
Docs-only PR applying Codacy markdownlint fixes — clean scope, no runtime risk. A few things worth noting:
Remaining inconsistencies in requirements-start.md
The PR description acknowledges that Codacy's patch was inconsistent. Two specific cases remain:
-
MD026 applied unevenly —
## Important Rules:and## Phase Transitions:still have trailing colons (MD026 violations) while sibling headings like## Full Workflowand## Question Formatshad theirs removed. This is the most likely source of the 2 CodeStyle issues flagged by the Codacy bot. -
MD022 still violated after
### Expert Questions (Phase 4)— the colon was stripped from the heading, but no blank line was added before the immediately-following code fence. The PR description calls this out explicitly.
These are minor and the PR body is transparent about them, but since the purpose of this PR is lint compliance it's worth deciding: either strip the remaining colons and add the missing blank line for full consistency, or leave them as a known exception and close out the Codacy warnings with an inline ignore comment.
Positive
- Good self-documentation in the PR body about what was changed and where the patch was inconsistent.
- Missing newline at end of
requirements-current.mdandrequirements-status.mdis fixed as a side effect. - All changes are confined to docs/
.claude/.github— zero risk to source, tests, or runtime behavior. - The
CONTRIBUTING.mdblank-line additions improve readability of the contribution guide.
Overall this is a low-risk, worthwhile cleanup. Addressing the two remaining lint issues before merge would make the improvement complete.
Code ReviewDocs-only PR applying Codacy markdownlint fixes — clean scope, no runtime risk. A few things worth noting: Remaining inconsistencies in
|
|
Addressed the two follow-up nits:
|
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.
…ING legal-notice period
924cd0d to
572ae77
Compare
There was a problem hiding this comment.
Code Review
This PR applies Codacy markdownlint fixes across documentation and instruction files only — no source or runtime changes. The changes are clean and low-risk.
What's Good
- Consistent MD022/MD032 blank-line insertions around headings and lists throughout all touched files
- MD047 trailing-newline fixes eliminate the subtle diff noise those missing newlines cause
- MD034 URL wrapping in
copilot-instructions.mdis correct (https://tunit.dev→<https://tunit.dev>) - The
CONTRIBUTING.mdblockquote fix (>blank line between the intro and the list) renders properly in GitHub markdown AnalyzerReleases.Shipped.mdchanges are safe — the RS2000 analyzer tolerates blank-line inserts around its####subheadings
One Remaining Lint Issue
In .claude/commands/requirements-start.md, the ## Metadata Structure heading is immediately followed by a code fence with no blank line:
## Metadata Structure
```jsonThis is still an MD022 violation (blank line required after heading before fenced code block). The other headings that precede code fences in this file (e.g. ### Expert Questions (Phase 4)) did get a blank line added, so this one was likely missed. Worth fixing in a follow-up or squashing into this PR before merge.
Verdict
The bulk of the changes are correct and the intent is solid. Aside from the single overlooked MD022 gap above, this is good to merge.
|
Finished the remaining markdownlint issues in |
Applies the Codacy code-quality patch across documentation and instruction files.
Rules applied
copilot-instructions.md)requirements-start.md)Scope
Docs /
.claude/.githubonly — 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 toFull Workflow,Question Formats,Expert Questions (Phase 4),Metadata Structurebut notImportant 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.AnalyzerReleases.Shipped.mdfiles are parsed by the RS2000 release-tracking analyzer; existing####subheadings already build, and blank-line inserts are tolerated.