sportsdataverse-js: Instructions file for GitHub Copilot

.github/copilot-instructions.md

sportsdataverse-js copilot-instructions.md is an instructions file for GitHub Copilot from sportsdataverse/sportsdataverse-js. It costs 2,011 tokens per session, scanned A, original, MIT.

A set of coding instructions for a TypeScript sports-data client whose API wrappers and reference pages are generated from endpoint definitions.

In plain words
What is it for?
Use it when adding or changing API endpoints, updating the source YAML or templates, running code generation, and checking for generated-file drift.
Why use it?
It prevents edits to generated files from being overwritten and keeps generated code, documentation, and metadata in sync.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions CLAUDE.md.

This is sportsdataverse/sportsdataverse-js's own configuration. It tells GitHub Copilot how to work on sportsdataverse-js itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything sportsdataverse-js configures →

Reuse

Borrowing it

Nothing to install: this file belongs to sportsdataverse/sportsdataverse-js. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/sportsdataverse/sportsdataverse-js/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/sportsdataverse/sportsdataverse-js

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for sportsdataverse-js copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/sportsdataverse/sportsdataverse-js/copilot-instructions/github.svg)](https://agentmods.dev/instructions/sportsdataverse/sportsdataverse-js/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/sportsdataverse/sportsdataverse-js/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/sportsdataverse/sportsdataverse-js/copilot-instructions/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for sportsdataverse-js copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/sportsdataverse/sportsdataverse-js/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/sportsdataverse/sportsdataverse-js/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 2,011 This file is loaded in full into every session.
When invoked 2,011 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.02011 $0.02011
Opus 5.5 $0.00804 $0.00804
Sonnet 5.5 $0.00402 $0.00402
Haiku 4.5 $0.00201 $0.00201

Measured 17d ago against content hash 8dc7c8466cb4, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

sportsdataverse-js copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 17d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/copilot-instructions.md · 110 lines

How it starts

The opening of the file, as written. The whole thing — 110 lines — stays where its author put it; the contents beside it link to each section on GitHub.

GitHub Copilot instructions — sportsdataverse (Node.js)

A TypeScript, ESM-only Node.js client (Node ≥ 20.18.1; developing needs ^20.19 / ≥ 22.12 for mocha 12 + c8 12) for sports data: 126 ESPN endpoints on 40 leagues, 1059 flat-API wrappers across 27 families (14 league families, 13 provider families), 323 release-dataset loaders, one parser layer, one error vocabulary. Public names are sportsdataverse-py's. CLAUDE.md is the deep-dive; this file is the short version.

Architecture — five surfaces, one generator

tools/codegen/generate.mjs is a pure file-in / file-out renderer (no network) over tools/codegen/endpoints/*.yaml + schemas/. It writes src/generated/** (wrappers, leagues, aliases, namespaces, espn/<league>.ts, flat/<family>.ts, params/, rows/, loaders/, loader_rows/, utilities.ts), the docs (docs/docs/<league>/, docs/docs/reference/, docs/docs/utilities/, the <!-- gen:status --> blocks of docs/docs/architecture/, docs/src/generated/) and docs/src/playground/endpoints.json.

  • Vendored (sdv-py owns it): the ESPN families, leagues, releases.yaml, loader_schemas.yaml, mlb, mlb_statcast, nfl_api, the four nhl_*, cbs, fox, yahoo, torvik, sports247*, on3, nba_stats, wnba_stats, the subscription and keyless families, every returns schema they reference, and the two column-description files. npm run vendor -- --ref <sha> copies them verbatim into tools/codegen/vendor/upstream/ (hash LOCK) and derives endpoints/ + schemas/. Change them in sdv-py first; JS-side patches go in tools/codegen/overlay/<family>.yaml.
  • JS-owned YAML: hockeytech, odds_api, yahoo_scores, recruiting, espn_parser_map.yaml, utilities.yaml, breaking.yaml, vendor.yaml — edit here.
  • Hand-written TypeScript (src/): parsers, analytics, odds math, cricket WP, producers, discovery, the HTTP core (request → transport → retry → classify), the legacy get* services. Catalogued by utilities.yaml (a listed export the source lacks fails codegen).
  • Loaders: one load* per releases.yaml entry; src/core/releases.ts decodes parquet with hyparquet, skips a 404 season, applies the INT64 policy.
  • Namespace assembly (src/index.ts): legacy services → makeLeagueModule (ESPN) → makeFlatModule (flat, additive, never clobbering; FLAT_API_NAMESPACES must match the copy in generate.mjs) → hand-written extras.

Read the full file on GitHub · 110 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 17d ago Changed 8dc7c8466cb4
  2. 29d ago Changed · +3 tokens per session 21dfa7e9ffb5
  3. 1mo ago Changed · +31 lines · +679 tokens per session 7150b2350c64
  4. 1mo ago Changed · +7 lines · +91 tokens per session 6c993a7f1ac1
  5. 2mo ago First seen · 72 lines · 1,238 tokens per session scan A 70c7abe35d0c

Subscribe to this mod's changes

sportsdataverse-js copilot-instructions.md is an instructions file published in the GitHub repository sportsdataverse/sportsdataverse-js (88 stars, last pushed yesterday), licensed MIT. It adds 2,011 tokens to every session, about $0.0080 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

sportsdataverse-js copilot-instructions.md compared with instructions from other repositories

sportsdataverse-js copilot-instructions.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
sportsdataverse-js copilot-instructions.mdsportsdataverse/sportsdataverse-jsInstructions file88yesterdayMITA2,011GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode