Skip to content

docs: fix linting scripts README and instruction file gaps (#1107) #1948

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.

Sign up for GitHub

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

Open
PratikWayase wants to merge 2 commits into
base: main
Choose a base branch
from
+34 −0
Open

docs: fix linting scripts README and instruction file gaps (#1107) #1948

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23890f9
docs: fix linting scripts README and instruction file gaps (#1107)
PratikWayase Jun 14, 2026
1a9d32f
docs: update schema count to 19 in linting README
PratikWayase Jun 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,8 @@ Agents should use npm scripts for all validation:
* `npm run lint:py` - Python linting via ruff
* `npm run lint:models` - Model reference validation against catalog
* `npm run lint:models:refresh` - Refresh model catalog from upstream documentation
* `npm run lint:permissions` - Workflow permissions validation
* `npm run lint:dependency-pinning` - Dependency pinning and SHA staleness validation
* `npm run lint:all` - Run all linters (chains `format:tables`, `lint:md`, `lint:ps`, `lint:yaml`, `lint:links`, `lint:frontmatter`, `lint:collections-metadata`, `lint:marketplace`, `lint:version-consistency`, `lint:permissions`, `lint:dependency-pinning`, `lint:py`, `validate:skills`, `lint:ai-artifacts`, and `lint:models`)
* `npm run validate:copyright` - Copyright header validation
* `npm run validate:skills` - Skill structure validation
Expand Down
32 changes: 32 additions & 0 deletions scripts/linting/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,6 +631,38 @@ Markdown link checker configuration.
* Timeout: 10 seconds
* Ignore patterns: Localhost, example.com

## Schemas Directory

The `schemas/` directory contains JSON schema files used for frontmatter validation. These schemas ensure that the metadata in various markdown and configuration files adheres to the expected structure.

### Schema Files

The directory includes the following 10 JSON schema files:

* `agent-frontmatter.schema.json`

@katriendg katriendg Jun 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the issue itself, it now has updated information about the full list to document here.

* `base-frontmatter.schema.json`
* `chatmode-frontmatter.schema.json`
* `collection-manifest.schema.json`
* `docs-frontmatter.schema.json`
* `instruction-frontmatter.schema.json`
* `marketplace-manifest.schema.json`
* `prompt-frontmatter.schema.json`
* `root-community-frontmatter.schema.json`
* `skill-frontmatter.schema.json`
* `accessibility-state.schema.json`
* `adr-config.schema.json`
* `adr-consistency-rules.schema.json`
* `adr-frontmatter.schema.json`
* `ai-artifact-config.schema.json`
* `model-catalog.schema.json`
* `rai-state.schema.json`
* `security-state.schema.json`
* `sssc-state.schema.json`

### Schema Mapping

* `schema-mapping.json`: Maps glob patterns to their corresponding JSON schemas for targeted validation.

## Testing

All scripts support local testing before running in GitHub Actions:
Expand Down