design-system: Instructions file for GitHub Copilot

.github/instructions/pr-review.instructions.md

design-system pr-review.instructions.md is an instructions file for GitHub Copilot from iress/design-system. It costs 3,034 tokens per session, scanned A, original, Apache-2.0.

Pull-request review instructions for the Iress Design System, a shared React component library and design-token collection. They include checks for documentation and package versions used in CodeSandbox and Storybook examples.

In plain words
What is it for?
Reviewing pull requests, checking documentation freshness, and verifying dependencies in Storybook previews, CodeSandbox examples, mock stories, utilities, and documentation snippets.
Why use it?
They help reviewers catch changes that leave the project’s AI guidance or examples out of date. They also prevent sandbox examples from using an outdated package release tag.

Instructions file for GitHub Copilot

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

This is iress/design-system's own configuration. It tells GitHub Copilot how to work on design-system 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 design-system configures →

Reuse

Borrowing it

Nothing to install: this file belongs to iress/design-system. 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/iress/design-system/main/.github/instructions/pr-review.instructions.md
Clone the repo
git clone --depth 1 https://github.com/iress/design-system

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 design-system pr-review.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/iress/design-system/pr-review/github.svg)](https://agentmods.dev/instructions/iress/design-system/pr-review)
Your own site
<a href="https://agentmods.dev/instructions/iress/design-system/pr-review"><img src="https://agentmods.dev/badge/instructions/iress/design-system/pr-review/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 design-system pr-review.instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/iress/design-system/pr-review"><img src="https://agentmods.dev/badge/instructions/iress/design-system/pr-review.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,034 This file is loaded in full into every session.
When invoked 3,034 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.03034 $0.03034
Opus 5.5 $0.01214 $0.01214
Sonnet 5.5 $0.00607 $0.00607
Haiku 4.5 $0.00303 $0.00303

Measured 2mo ago against content hash 78c03f5b54ef, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

design-system pr-review.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 2mo 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/instructions/pr-review.instructions.md · 187 lines

How it starts

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

PR Review Instructions

Coding standards, domain knowledge, and preferences that AI should follow when reviewing pull requests.

AI Context & Documentation Freshness Checks

When reviewing a PR, always verify that AI-facing documentation stays in sync with code changes. Flag any missing updates as required changes (not suggestions).

Sandbox Dependency Tags

Trigger: Any PR that modifies CodeSandbox examples, Storybook sandbox defaults, or docs/snippets that generate package.json files for sandbox usage.

What to verify:

  • IDS v6 sandbox examples use the current prerelease tag: @iress-oss/ids-components: 'beta' and @iress-oss/ids-tokens: 'beta' when tokens are installed directly.
  • Review generated sandbox dependencies in Storybook previews, sandbox stories, mock stories, helper utilities, and README/MDX examples — not just the visible docs page.
  • Flag any use of alpha for IDS sandbox dependencies unless the PR explicitly documents a temporary rollback and explains why.

Review comment template:

This PR updates a CodeSandbox or Storybook sandbox example but still references IDS alpha packages. IDS v6 sandboxes should use the beta tag for @iress-oss/ids-components and @iress-oss/ids-tokens so generated examples install the current prerelease.

1. Token Schema — packages/tokens/.ai/index.json

Trigger: Any PR that modifies files under packages/tokens/src/schema/ or changes the design token build pipeline (packages/tokens/src/generated/, token transforms, or token build config).

What to verify:

  • If a new token category is introduced, packages/tokens/.ai/index.json has a new entry in tokenCategories with the correct name, description, schemaSource, and cssVariablePrefix.
  • If a token category is removed, its entry is deleted from tokenCategories.
  • If token values, descriptions, or structure change significantly, verify that the description fields in index.json still accurately reflect the token category.

Read the full file on GitHub · 187 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. 2mo ago First seen · 187 lines · 3,034 tokens per session scan A 78c03f5b54ef

Subscribe to this mod's changes

design-system pr-review.instructions.md is an instructions file published in the GitHub repository iress/design-system (1 stars, last pushed 2d ago), licensed Apache-2.0. It adds 3,034 tokens to every session, about $0.0121 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-31.

Related

design-system pr-review.instructions.md compared with instructions from other repositories

design-system pr-review.instructions.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
design-system pr-review.instructions.mdiress/design-systemInstructions file12d agoApache-2.0A3,034GitHub 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