apex-accelerator: Instructions file for GitHub Copilot

.github/instructions/code-quality.instructions.md

apex-accelerator code-quality.instructions.md is an instructions file for GitHub Copilot from jonathan-vella/apex-accelerator. It costs 827 tokens per session, scanned A, original, MIT.

Code-quality guidance focused on useful comments and review priorities, including security checks. It says comments should explain why non-obvious code exists, while language-specific rules still apply.

In plain words
What is it for?
Use it during code reviews and implementation to decide what to comment, check for security concerns, and follow additional rules for PowerShell, Bicep, and shell scripts.
Why use it?
Comments that merely repeat the code become noise and can go stale. This helps reviewers and maintainers focus on decisions, unusual logic, and security risks.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

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

Reuse

Borrowing it

Nothing to install: this file belongs to jonathan-vella/apex-accelerator. 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/jonathan-vella/apex-accelerator/main/.github/instructions/code-quality.instructions.md
Clone the repo
git clone --depth 1 https://github.com/jonathan-vella/apex-accelerator

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 apex-accelerator code-quality.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/jonathan-vella/apex-accelerator/code-quality/github.svg)](https://agentmods.dev/instructions/jonathan-vella/apex-accelerator/code-quality)
Your own site
<a href="https://agentmods.dev/instructions/jonathan-vella/apex-accelerator/code-quality"><img src="https://agentmods.dev/badge/instructions/jonathan-vella/apex-accelerator/code-quality/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 apex-accelerator code-quality.instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/jonathan-vella/apex-accelerator/code-quality"><img src="https://agentmods.dev/badge/instructions/jonathan-vella/apex-accelerator/code-quality.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 827 This file is loaded in full into every session.
When invoked 827 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.00827 $0.00827
Opus 5.5 $0.00331 $0.00331
Sonnet 5.5 $0.00165 $0.00165
Haiku 4.5 $0.00083 $0.00083

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

Security

Grade A, and why

apex-accelerator code-quality.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 6d 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/code-quality.instructions.md · 97 lines

How it starts

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

Code Quality Instructions

Language-Specific Precedence

Language-specific instruction files take precedence over these general guidelines. In particular:

  • PowerShell (powershell.instructions.md): always include comment-based help (.SYNOPSIS, .DESCRIPTION, .EXAMPLE).
  • Bicep (iac-bicep-best-practices.instructions.md): always use @description annotations on parameters, variables, and outputs.
  • Shell (shell.instructions.md): include a header comment explaining the script's purpose.

These requirements are additive — public-facing APIs and parameters must be documented per their language rules, while internal code follows the minimal-comment philosophy below.


Commenting: Core Principle

Write code that speaks for itself. Comment only when necessary to explain WHY, not WHAT.

AVOID These Comments

  • Obvious: let counter = 0; // Initialize counter to zero
  • Redundant: comment repeats what the code already says
  • Outdated: comment doesn't match the code

WRITE These Comments

  • Complex business logic: explains WHY a specific calculation
  • Non-obvious algorithms: explains the algorithm choice
  • Regex patterns: explains what the regex matches
  • API constraints or gotchas: explains external limitations

Decision Framework

  1. Is the code self-explanatory? → No comment needed
  2. Would a better name eliminate the need? → Refactor instead
  3. Does this explain WHY, not WHAT? → Good comment
  4. Will this help future maintainers? → Good comment

Annotations

Use standard annotation tags: TODO, FIXME, HACK, NOTE, WARNING, PERF, SECURITY, BUG, REFACTOR, DEPRECATED.

Anti-Patterns

  • Dead code left as comments — delete it (Git has history)
  • Journal comments tracking changes — use Git log
  • Closing brace comments — refactor into smaller functions
  • Commented-out code blocks — delete or explain why kept

Code Review Priorities

🔴 CRITICAL (Block merge): Security vulns, logic errors, breaking changes, data loss

Read the full file on GitHub · 97 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. 6d ago Changed · +7 tokens per session d9fd43d7266d
  2. 1mo ago Changed · -12 lines · -114 tokens per session 02bb11577a2c
  3. 1mo ago Changed · -9 tokens per session 5223713c1f41
  4. 1mo ago First seen · 109 lines · 943 tokens per session scan A e1dcd1935f2f

Subscribe to this mod's changes

apex-accelerator code-quality.instructions.md is an instructions file published in the GitHub repository jonathan-vella/apex-accelerator (50 stars, last pushed yesterday), licensed MIT. It adds 827 tokens to every session, about $0.0033 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

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,786 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

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens