caddis-plugin: Instructions file for GitHub Copilot

.github/instructions/data-contracts.instructions.md

caddis-plugin data-contracts.instructions.md is an instructions file for GitHub Copilot from saajunaid/caddis-plugin. It costs 1,522 tokens per session, scanned A, original, MIT.

Instructions for keeping data consistent as it moves from a source through a backend to a frontend. They cover data-transfer objects, contract tests, example payloads, display data, and frontend types.

In plain words
What is it for?
Use them when building or changing applications with a source-to-backend-to-frontend data pipeline.
Why use it?
They reduce mismatches between what a backend sends and what the frontend expects to receive.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

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

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is python scripts/drift_check.py --payload tests/fixtures/payloads/source/sample.json --dto src/models/responses/source_dto.py.

Reuse

Borrowing it

Nothing to install: this file belongs to saajunaid/caddis-plugin. 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/saajunaid/caddis-plugin/main/.github/instructions/data-contracts.instructions.md
Clone the repo
git clone --depth 1 https://github.com/saajunaid/caddis-plugin

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 caddis-plugin data-contracts.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/saajunaid/caddis-plugin/data-contracts/github.svg)](https://agentmods.dev/instructions/saajunaid/caddis-plugin/data-contracts)
Your own site
<a href="https://agentmods.dev/instructions/saajunaid/caddis-plugin/data-contracts"><img src="https://agentmods.dev/badge/instructions/saajunaid/caddis-plugin/data-contracts/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 caddis-plugin data-contracts.instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/saajunaid/caddis-plugin/data-contracts"><img src="https://agentmods.dev/badge/instructions/saajunaid/caddis-plugin/data-contracts.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,522 This file is loaded in full into every session.
When invoked 1,522 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.01522 $0.01522
Opus 5.5 $0.00609 $0.00609
Sonnet 5.5 $0.00304 $0.00304
Haiku 4.5 $0.00152 $0.00152

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

Security

Grade A, and why

caddis-plugin data-contracts.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 1mo 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/data-contracts.instructions.md · 196 lines

How it starts

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

Data Contract Conventions

Rules for building and maintaining typed data pipelines from source payload to frontend display.


Layer Architecture

Every data pipeline has up to 6 layers. Not all are required for every project.

Source → Adapter → Ingestion Model → Normalizer → Display DTO → API Router → Frontend Types/Services
Layer Location Responsibility
Source Adapter src/services/adapters/ or src/services/ Fetches raw data from external source (API, file, DB)
Ingestion Model src/models/ingestion/ 1:1 Pydantic model matching raw source payload shape
Normalizer src/services/normalizers/ Transforms ingestion model → display DTO (business logic lives here)
Display DTO src/models/responses/ Frozen Pydantic model defining the API boundary contract
API Router src/api/routers/ FastAPI endpoint returning typed response_model
Frontend Types frontend/src/types/ TypeScript interfaces mirroring display DTO
Frontend Service frontend/src/services/ Typed axios/fetch functions consuming API endpoints

Display DTO Rules

Field Aliasing

When JSON source uses camelCase but Python uses snake_case, use Field(alias=...):

from pydantic import BaseModel, Field

class CustomerScore(BaseModel):
    customer_id: str = Field(alias="customerId")
    net_promoter_score: float = Field(alias="netPromoterScore")

    model_config = ConfigDict(populate_by_name=True)

No Silent Data Dropping

# ❌ CRITICAL: Silently drops unknown fields — data loss bug
class SurveyData(BaseModel):
    model_config = ConfigDict(extra="ignore")

# ✅ GOOD: Explicit about every field; unknown fields cause validation error
class SurveyData(BaseModel):
    model_config = ConfigDict(extra="forbid")

# ✅ ALSO GOOD: Allow extras during migration, but log them
class SurveyData(BaseModel):
    model_config = ConfigDict(extra="allow")

Rule: Display DTOs at the API boundary must never use extra="ignore". Use extra="forbid" (strict) or extra="allow" (migration period) with logging.

Read the full file on GitHub · 196 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. 1mo ago First seen · 196 lines · 1,522 tokens per session scan A a5c6d69444c7

Subscribe to this mod's changes

caddis-plugin data-contracts.instructions.md is an instructions file published in the GitHub repository saajunaid/caddis-plugin (0 stars, last pushed today), licensed MIT. It adds 1,522 tokens to every session, about $0.0061 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

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,581 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens