docs: fix linting scripts README and instruction file gaps (#1107)#1948
docs: fix linting scripts README and instruction file gaps (#1107)#1948PratikWayase wants to merge 2 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1948 +/- ##
==========================================
- Coverage 80.63% 80.62% -0.01%
==========================================
Files 117 117
Lines 19089 19089
==========================================
- Hits 15392 15391 -1
- Misses 3697 3698 +1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
Hey @PratikWayase — thank you for picking this up! The changes to Unfortunately this is on us: the issue itself was written when the Would you be able to update the schemas section to include all 19? Happy to help if you'd like a list — just let me know! |
|
For reference, these are the 9 schemas that were added after the issue was filed and need to be included in the README section:
Also a minor note: |
katriendg
left a comment
There was a problem hiding this comment.
Please see my comments around some missing content before we merge. Thank you!
|
|
||
| The directory includes the following 10 JSON schema files: | ||
|
|
||
| * `agent-frontmatter.schema.json` |
There was a problem hiding this comment.
See the issue itself, it now has updated information about the full list to document here.
bindsi
left a comment
There was a problem hiding this comment.
Approved: the linting README and instruction updates are documentation-only and align with the current validation surface. I did not find actionable issues.
bindsi
left a comment
There was a problem hiding this comment.
Approved: the linting documentation updates align with the current validation surface. I did not find actionable issues in the current head.
Description
This PR resolves documentation coverage gaps in the linting scripts and instruction files as outlined in Issue #1107. Specifically, it makes the following updates:
scripts/linting/README.md: Added comprehensive documentation for theschemas/directory, listing all 10 JSON schema files and theschema-mapping.jsonmapping file..github/copilot-instructions.md: Explicitly addedlint:permissionsandlint:dependency-pinningto the "Using npm Scripts" list to ensure they are documented as individual scripts, alongside their existing inclusion in thelint:allchain.(Note: Documentation for missing scripts, modules, and the workflows table was already present in the repository, so this PR focuses strictly on the remaining gaps identified in the issue).
Related Issue(s)
Fixes #1107
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
Verified locally by running:
npm run lint:md(Passed with 0 errors)npm run lint:frontmatter(Passed validation for all modified files)validate:frontmatterno longer exists and the new schema documentation is correctly placed.Checklist
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
Additional Notes
Pre-existing frontmatter validation errors in
.github/skills/design-thinking/(related to "Standard Copilot footer") are unrelated to the changes in this PR and were present before these documentation updates.