Adopt shared markdownlint config and lint-clean docs#330
Merged
Conversation
Carry the template's .markdownlint-cli2.jsonc verbatim so the davidanson IDE extension and CLI markdownlint-cli2 apply the same rules. Normalize blank lines around headings/fences/lists and label one fenced block in copilot-instructions.md so the repo passes cleanly under the shared config (0 errors). The existing .editorconfig already governs line endings (global crlf + lf overrides), so no editorconfig change was needed. Realigns with ptr727/ProjectTemplate. Part of #329.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns the repository’s Markdown linting and documentation formatting with the shared ptr727/ProjectTemplate conventions by adding a markdownlint-cli2 configuration and making documentation edits so the repo’s Markdown passes cleanly under that config.
Changes:
- Add a shared
.markdownlint-cli2.jsoncconfiguration at the repo root to standardize Markdown lint rules. - Normalize spacing/blank lines in
.github/copilot-instructions.mdto satisfy markdownlint rules. - Label the conventional-commit fenced block as
textand wrap a bare URL in angle brackets to avoid common markdownlint violations.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.markdownlint-cli2.jsonc |
Introduces a shared markdownlint-cli2 config so IDE/CLI/CI linting uses the same rules. |
.github/copilot-instructions.md |
Formatting-only markdown cleanup (blank lines, fenced block language, bare URL) to lint-clean under the shared config. |
Add the template's 'PR Review Etiquette' contract to AGENTS.md and append the 'GitHub Copilot Review Runbook' to .github/copilot-instructions.md (owner/repo adapted to ptr727/Utilities). Both were previously absent, leaving an agent here with no in-repo pointer to the reliable Copilot review mechanics. Part of #329.
…nfig These files had pre-existing mixed CRLF/LF line endings; .editorconfig mandates CRLF for .md. Normalize both fully to CRLF so the carried template sections and the existing content share consistent, compliant endings.
This was referenced Jun 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses #329 - realign with ptr727/ProjectTemplate.
.markdownlint-cli2.jsoncverbatim; normalize blank lines / label a fence so docs pass clean.AGENTS.md..github/copilot-instructions.md(owner/repo adapted toptr727/Utilities)..editorconfig(they had pre-existing mixed CRLF/LF), and drop a whitespace-only line in a code example.Per your confirmation, this repo adopts the full review-loop docs despite being NuGet-only. Its
.editorconfigalready governs line endings, so no editorconfig rule change was needed.