eap-boot AGENTS.md

Repository guidance for EAP Boot, a Java 17 application made of multiple modules and shared with a separate common framework. It defines how agents should modify, test, and document the code.

In plain words
What is it for?
Use it when changing EAP Boot modules, Spring APIs, database behavior, dependency versions, shared framework integrations, tests, or build commands.
Why use it?
It reduces compatibility breakage by requiring focused changes, preserving APIs and package names, and testing the affected modules and shared dependencies.

Instructions file for CodexOpenCode

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/eaopen/eap-boot/agents-md
Clone the repo
git clone --depth 1 https://github.com/eaopen/eap-boot

Made for: Codex, OpenCode.

Per session 657 This file is loaded in full into every session.
When invoked 657 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 $0.00657 $0.00657
Opus 5 $0.00329 $0.00329
Sonnet 5 $0.00131 $0.00131
Haiku 4.5 $0.00066 $0.00066

Measured 2d ago against content hash fd1e534b0409, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

eap-boot AGENTS.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.

AGENTS.md · 40 lines

What it actually says

EAP Boot 协作指南

适用范围与入口

本文件适用于整个 eap-boot 仓库,是开发人员、Codex、Claude Code 及其他编码智能体的统一协作约定。规则仅在此维护,避免不同工具的说明重复或冲突。

  • 人工开发:开始修改前阅读本文件与 README.md
  • Codex:将本文件作为仓库级工作指引。
  • Claude Code:从 CLAUDE.md 跳转到本文件,不在 CLAUDE.md 重复维护规则。

仓库定位

  • eap-boot 是基于 Java 17 的 EAP 应用仓库;保持现有模块目录和全部 org.openea.eap 包名不变。
  • 本仓依赖同级 eap-common 的 BOM 和共享框架。共享框架变更后,必须先在 eap-common 安装新产物再验证本仓。
  • 参考 yudao 时仅适配实现,保留 EAP 模块、包名、集成和业务行为;禁止复制 cn.iocoder.yudao 包名或覆盖 EAP 定制代码。
  • 依赖与插件版本优先由根 POM 和 eap-common BOM 管理。子模块只有在存在已说明的兼容性要求时才能覆盖版本。

修改流程

  1. 先定位模块、接口调用方、数据模型与已有测试,再做最小范围修改。
  2. 保留无关的工作区改动;不执行未经要求的回退、批量格式化或删除;不修改 target/.flattened-pom.xml 等生成文件。
  3. 控制器、API、DTO、数据库字段和包名默认保持兼容。需要破坏性修改时,必须说明迁移方案和影响范围。
  4. Spring 测试必须显式提供所需的 mock;数据库空值规范化等持久化差异应在测试夹具或断言中处理。
  5. 修改模块职责、依赖版本、构建命令或运行前提时,同步更新 README 和相关技术文档。

验证与交付

  • 先运行受影响模块的测试;跨模块、共享框架或依赖升级必须运行完整测试与编译。
  • Mockito 在 JDK 17 上的动态 agent 提示为警告;测试或编译失败才是阻塞项。
  • 交付时说明:修改范围、验证命令、验证结果,以及尚未验证的风险(如有)。
# 在 ../eap-common:共享框架变更后先安装
mvn -q -DskipTests install

# 在 eap-boot 根目录:跨模块或依赖变更
mvn -q -Dflatten.skip=true test
mvn -q -U -DskipTests -Dflatten.skip=true compile
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 · 40 lines · 657 tokens per session scan A fd1e534b0409

Subscribe to this mod's changes

eap-boot AGENTS.md is an instructions file published in the GitHub repository eaopen/eap-boot (10 stars, last pushed 2d ago), licensed MIT. It adds 657 tokens to every session, about $0.0033 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-08-31.

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

buildNext

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

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

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

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

langchain 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,345 tokens