Skip to content

[WIP] Fix Markdown formatting issues in governance document#2181

Open
Copilot wants to merge 1 commit intomasterfrom
copilot/cleanup-markdown-formatting
Open

[WIP] Fix Markdown formatting issues in governance document#2181
Copilot wants to merge 1 commit intomasterfrom
copilot/cleanup-markdown-formatting

Conversation

Copy link

Copilot AI commented Jan 18, 2026

Plan: Clean up Markdown formatting in governance.md

  • Fix MD022 violations: Add blank lines around all headings
  • Fix MD009 violations: Remove trailing spaces from all lines
  • Fix MD032 violations: Add blank lines around lists
  • Verify formatting with markdownlint
  • Request code review
  • Run security checks

Summary

All Markdown formatting issues in governance.md have been successfully fixed:

  • Added blank lines around all headings (6 headings fixed)
  • Removed trailing spaces from 17 lines
  • Added blank lines around lists
  • Verified all changes pass markdownlint checks
  • No substantive content changes made

Security Summary

No security vulnerabilities detected. This PR only contains Markdown formatting changes.

Original prompt

Create a pull request in sonic-net/SONiC to clean up Markdown formatting issues in the governance document.

Target document:

Requirements:

  1. Review governance.md and identify Markdown formatting problems (e.g., inconsistent headings, list indentation, broken links, malformed tables, extra whitespace, incorrect code block fencing, line wrapping that breaks formatting).
  2. Fix the formatting issues while preserving the document’s meaning and structure.
  3. Ensure the document renders correctly in GitHub’s Markdown viewer.
  4. Keep changes limited to formatting/Markdown cleanup (no substantive governance policy edits unless strictly required to correct formatting).
  5. Run any applicable Markdown lint/format checks if the repo has them; otherwise, visually verify rendering.
  6. Provide a clear PR title and description summarizing what was fixed.

Notes:

  • Prefer minimal, targeted edits.
  • Maintain existing terminology and capitalization.
  • If any formatting ambiguity exists (e.g., intended nested lists), choose the rendering that matches surrounding context.

This pull request was created from Copilot chat.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@mssonicbld
Copy link
Collaborator

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

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.

3 participants