ai-instructions spring-boot-enum.instructions.md

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

A set of rules for defining Java enums in Spring Boot applications and using them consistently in APIs, domain code, and database boundaries.

In plain words
What is it for?
Use it when creating or reviewing enums for API requests, responses, messages, or stored domain values.
Why use it?
It prevents ambiguous names and inconsistent enum values from breaking data exchange or making code harder to understand. It also explains how to handle unknown values from outside systems.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot chat mode or prompt.

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/lsampaioweb/ai-instructions/spring-boot-enum
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-enum.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-enum.svg)](https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-enum)
Your own site
<a href="https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-enum"><img src="https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-enum.svg" alt="Measured on agentmods" height="20"></a>
Per session 451 This file is loaded in full into every session.
When invoked 451 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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.00451 $0.00451
Opus 5 $0.00226 $0.00226
Sonnet 5 $0.00090 $0.00090
Haiku 4.5 $0.00045 $0.00045

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

Security

Grade A, and why

ai-instructions spring-boot-enum.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/instructions/spring-boot-enum.instructions.md · 34 lines

How it starts

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

Spring Boot Enum

Naming Conventions

  • Use the *Enum suffix for all enum class names (e.g., UserStatusEnum, OrderStateEnum).
  • Include the domain context as a prefix in every enum class name (e.g., UserStatusEnum, not StatusEnum).
  • Use domain-specific enum names (never TypeEnum, StatusEnum, or other generic names without a domain prefix).

Rules

  • Keep enum values stable after public release.
  • Treat adding a new enum value to a public API contract as a breaking change.
  • Document new enum value additions in the API changelog.
  • Keep enum names expressive and domain-specific.
  • Keep enum-to-string behavior explicit when used in contracts.
  • Serialize enums as their name() string value in all API and message contracts (not ordinal).
  • Apply @JsonValue only when the serialized API value must differ from the Java constant name.
  • Declare a @JsonCreator factory method on enums used in API request bodies to control string-to-enum deserialization.
  • Add an UNKNOWN fallback constant annotated with @JsonEnumDefaultValue when the enum is sourced from an external API or message broker that may introduce new values.
  • Store application-owned enum domains in relational persistence through a dedicated lookup/reference table plus a foreign-key column in the business table.
  • Keep a stable code column in the lookup/reference table for mapping between the Java enum name() and the relational row.
  • Store enum values as strings in relational persistence only when the enum is external-system-owned, transient, or the user explicitly rejects a lookup/reference table design.
  • Declare enum constructor parameters as private and their backing fields as final.
  • Keep helper methods deterministic and side-effect free.

Safety Guards

  • Never repurpose existing enum values for new semantics.
  • Never introduce contract-breaking enum changes silently.
  • Never duplicate enum meaning in string literals across code.
  • Never use ordinal-style numeric persistence to represent enum meaning directly in a business table.

Read the full file on GitHub · 34 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 · 34 lines · 451 tokens per session scan A 9fbecec57efd

Subscribe to this mod's changes

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