Instruction file imported from Briggsby/DnD5eBattleApp (
.cursor/rules/update-agents-summary.mdc). Copyright stays with the author.
Maintain AGENTS.md
Read AGENTS.md at the repo root before substantive work on this codebase.
When to update
Include an AGENTS.md update in the same change when you modify anything that affects:
- Layer boundaries (
Engine/vsDnDEngine/) or game-loop flow - Interaction flows (menus, abilities, orders, rolls, encounters)
- JSON spec system, data folders, or
SchemaHandlerusage - Legacy vs new code paths (migration status, deprecations)
- Static singleton patterns or entry-point behavior
- Known gaps, TODOs, or "do not" guidance
When to skip
Do not update AGENTS.md for:
- Localized bug fixes that don't change documented behavior
- Internal refactors with no external API or flow change
- Formatting, comments, or variable renames
- Changes to files/patterns not described in
AGENTS.md
How to update
- Keep
AGENTS.mdconcise (~150 lines). Update existing sections; don't append changelogs. - Document behavior and architecture, not file inventories or class signatures.
- Remove stale guidance when replacing old patterns.
- If unsure whether an update is needed, ask: "Would a future agent make a wrong decision without this change?" Update only if yes.