Correct config comments flagged in review - #128
Merged
Conversation
- .markdownlint-cli2.jsonc: MD060 is the table-column-style rule (pipe spacing), not about wide/wrapping tables; rewrite the comment to say we don't enforce a table pipe-spacing style. - .editorconfig: the JSON section now globs json+jsonc, so update the header comment from 'Json files' to 'Json and JsonC files'. - AGENTS.md: the markdownlint --fix first-adoption step now uses the Docker invocation (consistent with 'Running the Linters Locally'), not a bare markdownlint-cli2 command.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects a few documentation/config comments to align with the actual markdownlint rule meanings and current config globs, keeping the template's shared linting guidance consistent for downstream derived repos.
Changes:
- Update
AGENTS.mdto reference the documented Docker invocation formarkdownlint-cli2when doing first-time--fixadoption. - Correct the
MD060comment in.markdownlint-cli2.jsoncto accurately describe that table column/pipe spacing style is intentionally not enforced. - Adjust the
.editorconfigsection header to reflect that it now targets both.jsonand.jsonc.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
AGENTS.md |
Aligns first-adoption markdownlint --fix guidance with the documented Docker invocation section. |
.markdownlint-cli2.jsonc |
Fixes the MD060 explanatory comment to match the rule's actual purpose (table column style). |
.editorconfig |
Updates the JSON header comment to match the {json,jsonc} glob. |
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.
Fixes three comment/consistency nits surfaced by Copilot on the downstream promotion PRs (the same template config propagated to derived repos, so fixing it here corrects the source - downstream picks it up on re-sync):
.markdownlint-cli2.jsonc: theMD060comment was wrong - MD060 is the table-column-style rule (pipe/column spacing), not about wide or wrapping tables. Rewrote it to say we don't enforce a table pipe-spacing style..editorconfig: the JSON section globsjson,jsoncnow, so the# Json filesheader is updated to# Json and JsonC files.AGENTS.md: the markdownlint--fixfirst-adoption step now uses the Docker invocation (consistent with "Running the Linters Locally") instead of a baremarkdownlint-cli2command.markdownlint clean; CRLF preserved.