Conversation
Part of #160 - realign with ptr727/ProjectTemplate. - Carry the template's [`.markdownlint-cli2.jsonc`](https://github.com/ptr727/ProjectTemplate/blob/main/.markdownlint-cli2.jsonc) **verbatim**, so the davidanson `markdownlint` IDE extension and CLI/CI `markdownlint-cli2` apply the same rules. - Add `jsonc` to the `.editorconfig` `[*.{json,jsonc}]` glob so the new config file is CRLF-governed (matches the template). - Normalize blank lines around headings/fences/lists in `.github/copilot-instructions.md` and label one fenced block, so the repo passes cleanly under the shared config (`markdownlint-cli2 "**/*.md"` = **0 errors**). **Note:** this repo's `.editorconfig` already carries the full per-extension `end_of_line` rules (the realignment issue's "crlf only under `[*.md]`" claim was inaccurate on inspection), so no EOL-rule change was needed beyond the jsonc glob. The remaining item in #160 - renaming the `Develop`/`Main` rulesets to lowercase `develop`/`main` - is a repo-settings change handled separately.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns the repository’s Markdown linting behavior with the shared template by introducing a markdownlint-cli2 configuration, updating EditorConfig to cover JSONC files, and adjusting documentation formatting to pass the new lint rules cleanly.
Changes:
- Added a
.markdownlint-cli2.jsoncconfig to standardize Markdown lint rules across CLI/CI and IDE usage. - Updated
.editorconfigso JSONC files inherit the same CRLF policy as JSON. - Reformatted
.github/copilot-instructions.md(blank lines around headings/lists/fences and a labeled fence) to be lint-clean under the shared config.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.markdownlint-cli2.jsonc |
Introduces the shared markdownlint-cli2 rule configuration used by CLI and editor tooling. |
.github/copilot-instructions.md |
Normalizes Markdown formatting (spacing + labeled fence) to comply with the lint rules. |
.editorconfig |
Expands JSON settings to include .jsonc so the new config file follows the intended EOL policy. |
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.
Promotes
developtomain: carry the template's.markdownlint-cli2.jsoncverbatim + jsonc editorconfig glob, lint-clean docs. (#162)