Skip to content

fix: Markdown-Lint errors in .github/copilot-instructions.md #123

@kevalyq

Description

@kevalyq

Problem

Pre-commit checks fail due to 88 markdown-lint errors in .github/copilot-instructions.md:

markdownlint-cli2 v0.18.1 (markdownlint v0.38.0)
Summary: 88 error(s)

Common errors:

  • MD022/blanks-around-headings: Headings should be surrounded by blank lines
  • MD032/blanks-around-lists: Lists should be surrounded by blank lines
  • MD012/no-multiple-blanks: Multiple consecutive blank lines
  • MD007/ul-indent: Unordered list indentation

This blocks git push operations and requires --no-verify to bypass.

Impact

  • ❌ Pre-commit hooks fail on all branches
  • ❌ Requires manual --no-verify on every push
  • ❌ Inconsistent code quality enforcement

Solution

Fix all markdown-lint violations in .github/copilot-instructions.md:

  1. Add blank lines around all headings
  2. Add blank lines around all lists
  3. Remove multiple consecutive blank lines
  4. Fix list indentation (use 2 spaces, not 4)

Acceptance Criteria

  • All markdown-lint errors fixed
  • Pre-commit hooks pass without --no-verify
  • File still readable and well-formatted
  • No functional changes to content

Commands to Test

# Check current errors
npx markdownlint-cli2 '.github/copilot-instructions.md'

# Auto-fix what's possible
npx markdownlint-cli2 --fix '.github/copilot-instructions.md'

# Verify pre-commit passes
./scripts/preflight.sh

Priority

Low - Does not block functionality, but affects developer experience.

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    ✅ Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions