-
Notifications
You must be signed in to change notification settings - Fork 5
chore: Update Markdown formatting standards and add Copilot integration guidance #111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -50,6 +50,6 @@ | |
|
|
||
| # Table pipe style - require spaces around cell content | ||
| "MD060": { | ||
| "style": "spaced" | ||
| "style": "aligned" | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -103,7 +103,8 @@ All Markdown files must satisfy the rules in `.markdownlint.yaml`: | |||||
| * **MD013** — line length: maximum 200 characters; code blocks and tables are exempt | ||||||
| * **MD022** — headings: one blank line above and below every heading | ||||||
| * **MD029** — ordered list style: use `1.` for every item, or true sequential numbers | ||||||
| * **MD060** — table separators: `| --- | --- |` with spaces, never `|---|---|` | ||||||
| * **MD060** — table column style: `"aligned"` — all column widths must be padded uniformly so | ||||||
| every pipe is vertically aligned; separator dashes must span the full column width | ||||||
|
|
||||||
| Rules explicitly disabled (permitted in this project): raw HTML (MD033), duplicate headings | ||||||
| across sections (MD024), emphasis as heading (MD036), language tag on fenced blocks (MD040), | ||||||
|
|
@@ -130,7 +131,7 @@ Before proposing or generating code, verify: | |||||
| * [ ] New tests added for new functionality — see `writing-tests` skill | ||||||
| * [ ] Commit message follows Conventional Commits format — see `writing-commits` skill | ||||||
| * [ ] Security implications reviewed for changes touching input, files, config, or external | ||||||
| commands — see `security-review` skill | ||||||
| commands — see `security-review` skill | ||||||
|
||||||
| commands — see `security-review` skill | |
| commands — see `security-review` skill |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This table appears malformed: it introduces extra empty columns and the “Assertion not reached” row is broken across cells (pipes/backslashes are being interpreted as table separators). This is likely to render incorrectly and may fail MarkdownLint table rules. Suggest reverting to a simple 3-column table and represent literals like
|| returnusing backticks within a single cell instead of trying to escape pipes with line breaks.