Skip to content

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

Open
jbampton wants to merge 1 commit into
apache:mainfrom
jbampton:enable-MD037
Open

jbampton wants to merge 1 commit 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 on lines 69 to 72
# MD036/no-emphasis-as-heading Emphasis used instead of a heading
MD036: false

# MD037/no-space-in-emphasis Spaces inside emphasis markers
MD037: false

# MD040/fenced-code-language Fenced code blocks should have a language specified
```

*** Common issues: ***
*** Common issues:
```

*** Common issues: ***
*** Common issues:
@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 19.91%. Comparing base (1a48a87) to head (a64a8bb).

Additional details and impacted files
@@            Coverage Diff            @@
##               main   #14290   +/-   ##
=========================================
  Coverage     19.91%   19.91%           
- Complexity    20199    20200    +1     
=========================================
  Files          6373     6373           
  Lines        577230   577230           
  Branches      70696    70696           
=========================================
+ Hits         114950   114961   +11     
+ Misses       449713   449703   -10     
+ Partials      12567    12566    -1     
Flag Coverage Δ
uitests 3.71% <ø> (ø)
unittests 21.18% <ø> (+<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.

This branch has not been deployed

No deployments
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.

2 participants