Skip to content

docs: enable markdownlint rule MD037; standardize Markdown; fix typo - #14290

Merged
DaanHoogland merged 3 commits into
apache:mainfrom
jbampton:enable-MD037
Nov 16, 2026
Merged

DaanHoogland merged 3 commits into
apache:mainfrom
jbampton:enable-MD037

Conversation

@jbampton

@jbampton jbampton commented Oct 1, 2026

Copy link
Copy Markdown
Member

Enforce no spaces inside emphasis markers

https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md037---spaces-inside-emphasis-markers

Clean up and standardize the Markdown and one minor typo fix

Description

This PR...

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • Build/CI
  • Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Copilot AI balanced review requested due to automatic review settings October 1, 2026 17:30

Copilot AI 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.

Copilot review overview

🟡 Changes recommended

The DevCloud edits leave unmatched emphasis markers, and an existing MD037 violation will fail pre-commit.

Review effort: Balanced
Findings: 1 High severity · 2 Low severity

Open (3)
What changed in this PR

Enables MD037 and standardizes affected Markdown formatting.

Changes:

  • Enables no-space-in-emphasis linting.
  • Corrects a search typo and VPC emphasis.
  • Updates DevCloud labels.
File Description
.github/​linters/​.markdown-lint.yml Enables MD037.
ui/​docs/​full-test-plan.template.md Fixes typo and emphasis spacing.
tools/​devcloud4/​basic/​README.md Updates emphasized labels.
tools/​devcloud4/​advanced/​README.md Updates emphasized labels.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/linters/.markdown-lint.yml Resolved
Comment thread tools/devcloud4/advanced/README.md Resolved
Comment thread tools/devcloud4/basic/README.md Resolved
@codecov

codecov Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 20.78%. Comparing base (f2ee0b7) to head (002f4c3).

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #14290      +/-   ##
============================================
- Coverage     20.78%   20.78%   -0.01%     
+ Complexity    20858    20857       -1     
============================================
  Files          6053     6053              
  Lines        548230   548230              
  Branches      73237    78374    +5137     
============================================
- Hits         113927   113925       -2     
- Misses       420955   420957       +2     
  Partials      13348    13348              
Flag Coverage Δ
uitests 3.86% <ø> (ø)
unittests 22.21% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jbampton
jbampton marked this pull request as draft October 3, 2026 04:30

@DaanHoogland DaanHoogland 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.

lgtm

@jbampton jbampton changed the title docs: enable markdownlint rule MD037; standardize Markdown docs: enable markdownlint rule MD037; standardize Markdown; fix typo Nov 16, 2026
@DaanHoogland

DaanHoogland commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

no production code; merging

AD. Not merging yet, is this ready for merge @jbampton ?

@jbampton
jbampton marked this pull request as ready for review November 16, 2026 10:19
Copilot AI balanced review requested due to automatic review settings November 16, 2026 10:19
@jbampton

Copy link
Copy Markdown
Member Author

no production code; merging

AD. Not merging yet, is this ready for merge @jbampton ?

Yes this is ready @DaanHoogland

Copilot AI 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.

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Copilot review overview

1 open issue
3 resolved since last review

Review effort: Lite

Comment thread .github/linters/.markdown-lint.yml Resolved
@DaanHoogland
DaanHoogland merged commit 278bde2 into apache:main Nov 16, 2026
45 of 46 checks passed
@DaanHoogland DaanHoogland added this to the 24.0 milestone Nov 16, 2026
@jbampton
jbampton deleted the enable-MD037 branch November 16, 2026 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants