Skip to content

AGENTS.md

Latest commit

 

History

History
37 lines (24 loc) · 1.78 KB

AGENTS.md

File metadata and controls

37 lines (24 loc) · 1.78 KB
Raw

AGENTS.md

Primary entry point for AI coding agents working on this repository. Tool-specific aliases (CLAUDE.md, GEMINI.md) redirect here.

📌 Single Source of Truth: Architecture, conventions, and developer reference live in GUIDE.md. Always refer to that file for project context.

Editing Rules

Before modifying any file, read and follow prompts/editing-rules.md. Key rules:

  • Never edit types/ or dist/ directly — auto-generated by build. Edit source .js files instead.
  • Never edit language files other than src/langs/en.js — other languages are auto-generated by translation script.
  • Never edit auto-generated marker sections in src/typedef.js and src/core/schema/options.js.
  • Three-file sync: src/suneditor.js, webpack/cdn-builder.js, scripts/ts-build/format-index.cjs must stay in sync.

Coding Rules

Before writing or modifying any .js file under src/, read prompts/coding-rules.md. Defines the enforceable conventions: events through eventManager, DOM mutations through $.html/$.format/$.inline, state through store/context/frameContext, iframe-safe checks, history/onChange wiring, plugin and module shapes, layer/import boundaries.

changes.md Update

After modifying code, you must update changes.md. Refer to prompts/changes-guide.md for formatting rules.

Release Note

When asked to write a release note, read changes.md and write a release note to release-note.md following the style and rules in prompts/release-note.md. Replace the entire contents of release-note.md with the generated release note.