Skip to content

Conversation

@kevalyq
Copy link
Contributor

@kevalyq kevalyq commented Nov 14, 2025

Summary

Fixes #123

Resolves all 88 markdown-lint errors in .github/copilot-instructions.md that were blocking pre-commit checks.

Changes

  • ✅ Added blank lines around headings (MD022)
  • ✅ Added blank lines around lists (MD032)
  • ✅ Removed multiple consecutive blank lines (MD012)
  • ✅ Fixed unordered list indentation to 2 spaces (MD007)
  • ✅ Applied Prettier formatting
  • ✅ Updated CHANGELOG.md

Verification

# Before: 88 errors
npx markdownlint-cli2 '.github/copilot-instructions.md'
# Summary: 88 error(s)

# After: 0 errors
npx markdownlint-cli2 '.github/copilot-instructions.md'
# Summary: 0 error(s)

Note on Pre-Push Hook

⚠️ Important: The pre-push hook currently fails due to unrelated MD060 errors in other files (docs/ISSUE50_RETROSPECTIVE.md, docs/PR_REVIEW_ISSUE50.md, docs/rbac-architecture.md, SECURITY.md). These errors existed before this PR and are not caused by these changes.

Verified clean:

  • .github/copilot-instructions.md - 0 errors
  • CHANGELOG.md - 0 errors

The MD060 errors should be addressed in a separate PR/issue.

Related

Fixes #123

- Added blank lines around headings (MD022)
- Added blank lines around lists (MD032)
- Removed multiple consecutive blank lines (MD012)
- Fixed unordered list indentation to 2 spaces (MD007)
- Applied Prettier formatting

All 88 markdown-lint errors now resolved, preflight checks pass.
@kevalyq kevalyq marked this pull request as ready for review November 14, 2025 21:32
Copilot AI review requested due to automatic review settings November 14, 2025 21:32
@github-actions
Copy link

💡 Tip: Consider Using Draft PRs

Benefits of opening PRs as drafts initially:

  • 💰 Saves CI runtime and Copilot review credits
  • 🎯 Automatically sets linked issues to "🚧 In Progress" status
  • 🚀 Mark "Ready for review" when done to trigger full CI pipeline

How to convert:

  1. Click "Still in progress? Convert to draft" in the sidebar, OR
  2. Use gh pr ready when ready for review

This is just a friendly reminder - feel free to continue as is! 😊

Copilot finished reviewing on behalf of kevalyq November 14, 2025 21:33
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR resolves 88 markdown-lint errors in .github/copilot-instructions.md by applying proper formatting rules, including adding blank lines around headings and lists, removing consecutive blank lines, and fixing list indentation. The changes are purely formatting-related with no functional impact on the content.

Key Changes:

  • Fixed markdown formatting violations in copilot instructions (MD022, MD032, MD012, MD007)
  • Updated CHANGELOG.md with details of the markdown-lint fixes

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
.github/copilot-instructions.md Fixed code snippet indentation and added blank lines per MD rules
CHANGELOG.md Added entry documenting the markdown-lint fixes under "Fixed"

- Consolidate CHANGELOG.md 'Fixed' sections (move markdown-lint entry to existing section)
- Fix code indentation inconsistency in copilot-instructions.md (remove extra indentation)

Addresses Copilot review feedback on PR #157
@kevalyq kevalyq merged commit 257c9d3 into main Nov 15, 2025
16 checks passed
@kevalyq kevalyq deleted the fix/markdown-lint-copilot-instructions branch November 15, 2025 03:06
@github-actions
Copy link

💡 Tip: Consider Using Draft PRs

Benefits of opening PRs as drafts initially:

  • 💰 Saves CI runtime and Copilot review credits
  • 🎯 Automatically sets linked issues to "🚧 In Progress" status
  • 🚀 Mark "Ready for review" when done to trigger full CI pipeline

How to convert:

  1. Click "Still in progress? Convert to draft" in the sidebar, OR
  2. Use gh pr ready when ready for review

This is just a friendly reminder - feel free to continue as is! 😊

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.

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

2 participants