rails-instructions: Instructions file for GitHub Copilot

.github/instructions/rails-importmaps.instructions.md

rails-instructions rails-importmaps.instructions.md is an instructions file for GitHub Copilot from levifig/rails-instructions. It costs 799 tokens per session, scanned A, original, MIT.

A set of Rails Import Maps instructions. Import Maps let browsers load JavaScript modules directly, so a Rails project can use JavaScript without a bundling or transpiling build step.

In plain words
What is it for?
Configuring JavaScript dependencies in importmap.rb, organizing Stimulus controllers and other modules, pinning libraries, and choosing CDN or local copies.
Why use it?
It reduces JavaScript build setup and keeps dependency choices in one configuration file. The rules also promote stable versions and consistent file naming.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

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

Reuse

Borrowing it

Nothing to install: this file belongs to levifig/rails-instructions. 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/levifig/rails-instructions/main/.github/instructions/rails-importmaps.instructions.md
Clone the repo
git clone --depth 1 https://github.com/levifig/rails-instructions

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 rails-instructions rails-importmaps.instructions.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/levifig/rails-instructions/rails-importmaps"><img src="https://agentmods.dev/badge/instructions/levifig/rails-instructions/rails-importmaps.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 799 This file is loaded in full into every session.
When invoked 799 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.00799 $0.00799
Opus 5.5 $0.00320 $0.00320
Sonnet 5.5 $0.00160 $0.00160
Haiku 4.5 $0.00080 $0.00080

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

Security

Grade A, and why

rails-instructions rails-importmaps.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/rails-importmaps.instructions.md · 119 lines

How it starts

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

Rails Import Maps Guide

Core Philosophy

  • Eliminate JavaScript build steps while maintaining modern development practices
  • Send JavaScript modules directly to the browser without bundling or transpiling
  • Reference external modules using standardized module specifiers
  • Embrace simplicity and developer happiness - this is the Rails Way™

Configuration Principles

  • Define all JavaScript dependencies in config/importmap.rb
  • Pin external libraries to specific versions for production stability
  • Use semantic versioning when pinning dependencies
  • Prefer CDN URLs for popular libraries to leverage browser caching
  • Vendor critical dependencies that cannot tolerate CDN failures
  • Always specify preload: true for essential modules

File Organization

  • Keep all JavaScript files in the app/javascript directory
  • Use controllers/ subdirectory exclusively for Stimulus controllers
  • Create components/ for reusable UI JavaScript modules
  • Create utilities/ for shared helper functions
  • Follow Rails naming conventions consistently

Naming Conventions for AI Agents

  • Name Stimulus controllers with *_controller.js suffix
  • Use descriptive nouns for component files (modal.js, dropdown.js)
  • Use action-based names for utilities (debounce.js, format_currency.js)
  • Maintain consistent naming patterns across the codebase
  • Document module purpose at the top of each file

Module Management

  • Import modules using standard ESM syntax
  • Avoid polluting the global namespace
  • Use named exports for better code discoverability
  • Keep modules focused on a single responsibility
  • Export only what needs to be public

Dependency Management

  • Pin to exact versions in production for stability
  • Use version ranges only in development
  • Regularly audit and update dependencies
  • Remove unused dependencies promptly
  • Document why each dependency is needed

Performance Optimization

  • Use preload: true only for critical dependencies
  • Implement lazy loading for features not needed on initial load
  • Leverage browser caching by using CDN URLs
  • Evaluate module size before adding dependencies
  • Consider vendoring large libraries that change infrequently

Read the full file on GitHub · 119 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 · 119 lines · 799 tokens per session scan A 2f77520a9b7a

Subscribe to this mod's changes

rails-instructions rails-importmaps.instructions.md is an instructions file published in the GitHub repository levifig/rails-instructions (56 stars, last pushed 1y ago), licensed MIT. It adds 799 tokens to every session, about $0.0032 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