EpubReader: Instructions file for GitHub Copilot

.github/copilot-instructions.md

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

Repository guidance for an AI coding agent working on EpubReader, a cross-platform .NET MAUI app for reading EPUB ebooks. It describes the app's layers, important files, and coding conventions.

In plain words
What is it for?
Use it when asking an agent to modify, debug, or extend the EpubReader app. It points work toward EPUB parsing, SQLite data, synchronization, view models, and platform wiring.
Why use it?
It gives the agent the project context needed to make focused changes without having to rediscover the architecture. It also helps preserve existing patterns such as MVVM, database storage, and platform-specific code.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

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

Reuse

Borrowing it

Nothing to install: this file belongs to ne0rrmatrix/EpubReader. 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/ne0rrmatrix/EpubReader/master/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/ne0rrmatrix/EpubReader

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 EpubReader copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/ne0rrmatrix/epubreader/copilot-instructions.svg)](https://agentmods.dev/instructions/ne0rrmatrix/epubreader/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/ne0rrmatrix/epubreader/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/ne0rrmatrix/epubreader/copilot-instructions.svg" alt="Measured on agentmods" height="20"></a>
Per session 2,970 This file is loaded in full into every session.
When invoked 2,970 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.02970 $0.02970
Opus 5 $0.01485 $0.01485
Sonnet 5 $0.00594 $0.00594
Haiku 4.5 $0.00297 $0.00297

Measured 2d ago against content hash 8232621d9bbd, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

EpubReader 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 2d 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 · 209 lines

How it starts

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

Copilot Instructions

EpubReader — Copilot instructions (concise)

This file tells an AI coding agent how to be immediately productive in the EpubReader repo (a cross-platform .NET MAUI EPUB reader). Keep edits focused, preserve style, and follow project conventions.

  • Big picture: .NET MAUI app with MVVM. Core responsibilities are split into:

    • UI & platform shims: Platforms/, Views/, and Controls/ (platform files use suffixes like .android.cs, .macios.cs).
    • Business logic & parsing: Service/EbookService.cs (VersOne.Epub + SixLabors.ImageSharp integrations).
    • Persistence & sync: Database/Db.cs, Service/FirebaseSyncService.cs, and secrets in build-secrets/.
    • Messaging & state: ViewModels/ (MVVM Toolkit attributes) and Messages/ (WeakReferenceMessenger).
  • Key files to inspect for most tasks:

    • Service/EbookService.cs — EPUB parsing, cover extraction
    • Database/Db.cs — SQLite initialization and models
    • MauiProgram.cs — DI registration and platform wiring
    • ViewModels/ — look for [ObservableProperty] and [RelayCommand]
    • Messages/ — message classes used with WeakReferenceMessenger
  • Build / Run

    • Primary build script: build.ps1. Example debug build: pwsh -File ./build.ps1 -ApiKey <key> -AuthDomain <domain> -DatabaseUrl <url> -Configuration Debug - VS Code tasks available: "Build with Firebase Secrets", "Build (Release) with Firebase Secrets", "Build from .env file", and "Run app (Windows)".
    • Secrets live in build-secrets/google-services.json or are passed via build.ps1 flags. Do not commit secrets.
  • Repository conventions (must follow)

    • File-scoped namespaces (e.g., namespace EpubReader.Service;).
    • Fields use camelCase, no underscore prefix.
    • Public async methods accept CancellationToken token = default and call token.ThrowIfCancellationRequested() early.
    • Use Trace.WriteLine() for logging (not Debug.WriteLine()).
    • Enums: index 0 should be Unknown/Default for safe deserialization.

Read the full file on GitHub · 209 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. 2d ago First seen · 209 lines · 2,970 tokens per session scan A 8232621d9bbd

Subscribe to this mod's changes

EpubReader copilot-instructions.md is an instructions file published in the GitHub repository ne0rrmatrix/EpubReader (15 stars, last pushed 14d ago), licensed MIT. It adds 2,970 tokens to every session, about $0.0149 per session on Opus 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-09-04.

Related

Other instructions, from other repositories

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,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

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 · 6,785 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 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,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens