ai-instructions: Instructions file for GitHub Copilot

.github/instructions/spring-boot-readme.instructions.md

ai-instructions spring-boot-readme.instructions.md is an instructions file for GitHub Copilot from lsampaioweb/ai-instructions. It costs 543 tokens per session, scanned A, original, MIT.

A set of rules for writing useful README files for Spring Boot projects. A README is the project guide that explains what the software does and how to run and configure it.

In plain words
What is it for?
Use it to document project overviews, required tool versions, startup commands, configuration, API references, and access URLs.
Why use it?
It gives developers verifiable setup instructions and the key project information without filler or missing prerequisites.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

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

Reuse

Borrowing it

Nothing to install: this file belongs to lsampaioweb/ai-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/lsampaioweb/ai-instructions/main/.github/instructions/spring-boot-readme.instructions.md
Clone the repo
git clone --depth 1 https://github.com/lsampaioweb/ai-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 ai-instructions spring-boot-readme.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-readme.svg)](https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-readme)
Your own site
<a href="https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-readme"><img src="https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-readme.svg" alt="Measured on agentmods" height="20"></a>
Per session 543 This file is loaded in full into every session.
When invoked 543 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.00543 $0.00543
Opus 5 $0.00271 $0.00271
Sonnet 5 $0.00109 $0.00109
Haiku 4.5 $0.00054 $0.00054

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

Security

Grade A, and why

ai-instructions spring-boot-readme.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 4d 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/spring-boot-readme.instructions.md · 43 lines

How it starts

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

README Engine

Rules

  • Include at minimum these sections in this order: (1) project title with one-line description, (2) Overview, (3) Prerequisites, (4) Getting Started, (5) Configuration reference.
  • Write the Overview as one paragraph.
  • Ensure the Overview answers what this service does.
  • Ensure the Overview answers who uses this service.
  • Ensure the Overview states the top one or two architectural decisions a developer will immediately encounter.
  • Do not repeat the title in the Overview.
  • Add an API reference section or link when the module exposes a public API.
  • Document only the project or module this README belongs to.
  • Do not describe cross-project dependencies or upstream systems inline.
  • Write only actionable content.
  • Omit prose that describes intent without providing executable or verifiable information.
  • State each prerequisite with its required version.
  • For each prerequisite, provide a verification command.
  • For each prerequisite, provide an install reference or link.
  • Write run instructions that can be executed verbatim without manual substitution.
  • After run instructions, list primary access URLs (API base URL, Swagger UI, Actuator health) so developers can immediately verify the running service.
  • Document required environment variables in Getting Started: each variable's name, purpose, and an example value.
  • Wrap all commands and code snippets in fenced code blocks with the appropriate language identifier.
  • Document Docker Compose run commands when the module includes a docker-compose.yml.
  • Document endpoint contracts or link to the canonical API documentation.
  • Document authentication and authorization behavior when applicable.
  • In the Configuration reference section, explain each setting's operational purpose and when a developer would need to change it.
  • When the module has multiple runtime profiles, document the intended use case for each profile.
  • Include concise rationale for key architecture decisions.
  • In the Configuration reference section, each entry must state: file path, property key or setting name, and effective value or behavior.
  • Omit entries that contain only a file path with no actionable detail.
  • Link to deeper technical documentation instead of duplicating long walkthroughs inline.
  • Include a Troubleshooting section covering common startup failures: database or broker connection errors, port conflicts, and missing environment variables.

Read the full file on GitHub · 43 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. 4d ago First seen · 43 lines · 543 tokens per session scan A e55488901137

Subscribe to this mod's changes

ai-instructions spring-boot-readme.instructions.md is an instructions file published in the GitHub repository lsampaioweb/ai-instructions (1 stars, last pushed 15d ago), licensed MIT. It adds 543 tokens to every session, about $0.0027 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-03.

Related

Other instructions, from other repositories

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

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

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

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

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