Skip to content

fix: correct examples.md description and document script directory boundary #25

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

Merged
CodeSigils merged 1 commit into from
Aug 21, 2026
Merged

fix: correct examples.md description and document script directory boundary #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,21 @@ The `What:` and `Why:` lines should describe the concrete change and its
motivation. Release notes are generated from the commit history; this project
does not maintain a separate changelog.

## Script directories

The repository has two script directories with different scopes:

- **`scripts/`** — Standalone CLI tools that auto-detect the repo root via
`_common.ROOT`. Safe to run from any working directory. Contains validation,
health checks, and the skill validator.
- **`.github/scripts/`** — CI-specific helpers. May assume the repo root is the
working directory and use hardcoded paths. Contains URL contract verification,
marketplace URL checks, and CI-specific validators.

When adding new scripts, prefer `scripts/` for anything a contributor might run
locally. Use `.github/scripts/` only for logic that depends on CI context (GitHub
API tokens, workflow-specific paths, PR creation).

## Validation

Run the relevant checks before opening a pull request:
Expand Down
4 changes: 2 additions & 2 deletions skills/skill-discovery/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,8 @@ creator when available rather than inventing platform-specific metadata.
inspection and safety checklist.
- [`references/skill-format.md`](references/skill-format.md): frontmatter spec,
description quality criteria, folder purposes, and client extensions.
- [`references/examples.md`](references/examples.md): portable local-search and
recommendation examples.
- [`references/examples.md`](references/examples.md): portable code snippets for
searching skill catalogs and locating skill files.

Load only the reference needed for the current stage. Re-verify volatile external
contracts against provider documentation whenever possible.