fix(settings): remove markdownlint exclusion for collections/*.collection.md#1372
fix(settings): remove markdownlint exclusion for collections/*.collection.md#1372PratikWayase wants to merge 4 commits intomicrosoft:mainfrom
Conversation
|
Thanks for your contribution @PratikWayase - I believe it will be good to hold off the changes on the collection MD files until PR #1316 is merged as it touches the same files, and you may have some conflicts. FYI @WilliamBerryiii |
|
Thanks for your work on this one @PratikWayase, nothing we have a PR out that needs to be merged first, and simplifies some of the work: #1316. Then this one can be rebased and simplified: After #1316 merges, the auto-generated artifact tables will be lint-compliant by construction. The only pieces of which would still be needed are:
Thank you for your patience |
WilliamBerryiii
left a comment
There was a problem hiding this comment.
Thank you so much for picking up #1341, @PratikWayase! The em-dash cleanup, the conversion away from bold-prefix list items, and adding H1s for MD041 all landed cleanly across the 14 collection files, and that is exactly the writing-style direction we have been moving toward. We really appreciate the care you put into this.
Before we merge, we left a few inline suggestions we would love your help tightening up. Happy to pair on any of these if it would be easier.
One last small note for after we land this: please run npm run plugin:generate as the final step so the plugins/ outputs and extension/README.*.md regenerate from the updated collection bodies. Those files are generated, so they need to flow through after the source changes.
Thank you again for tackling this, @PratikWayase. The writing-style improvements here are genuinely useful, and we are looking forward to getting this merged once the items below are sorted. Let us know if you would like a hand with any of them.
|
Hi @PratikWayase — thanks for picking this up. Quick status update: PR #1316 merged after you opened this, and it changed the contract for Rather than ask you to redo a large rebase, I'm going to push a rework directly to this branch with you kept as the commit author so you retain credit for #1341. The new shape is much smaller:
Two asks before I push:
I'll hold off ~24h for your reply, then proceed. Appreciate the contribution. |
|
Yes, "Allow edits from maintainers" is enabled. Feel free to proceed. |
- remove collections/*.collection.md from .markdownlint-cli2.jsonc ignores - add H1 titles, Included Artifacts headings, and blockquote previews to all 13 collection manifests - replace em-dashes with hyphens in design-thinking instructions/prompts frontmatter and in-scope docs - update Prepare-Extension.ps1 generator to emit Included Artifacts header - regenerate plugins/**/README.md for all 13 collections Closes microsoft#1341 🧹 - Generated by Copilot Co-authored-by: WilliamBerryiii <williamberry@github.com>
85bfea2 to
c5b7982
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1372 +/- ##
==========================================
- Coverage 87.44% 87.16% -0.28%
==========================================
Files 68 67 -1
Lines 10335 10067 -268
==========================================
- Hits 9037 8775 -262
+ Misses 1298 1292 -6
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Pull Request
Description
Removed the exclusion for
collections/*.collection.mdfrom markdownlint configuration and fixed all related lint violations across collection files.Changes include:
Validate-MarkdownFrontmatter.ps1to align with updated linting rulesRelated Issue(s)
Closes #1341
Type of Change
Select all that apply:
Code & Documentation:
Infrastructure & Configuration:
AI Artifacts:
prompt-builderagent and addressed all feedback.github/instructions/*.instructions.md).github/prompts/*.prompt.md).github/agents/*.agent.md).github/skills/*/SKILL.md)Other:
.ps1,.sh,.py)Testing
npx markdownlint-cli2 "collections/*.collection.md"→ 0 errorsnpm run lint:md→ 0 errorsChecklist
Required Checks
AI Artifact Contributions
/prompt-analyzeto review contributionprompt-builderreviewRequired Automated Checks
npm run lint:mdnpm run spell-checknpm run lint:frontmatternpm run validate:skillsnpm run lint:md-linksnpm run lint:psnpm run plugin:generatenpm run docs:testSecurity Considerations