Skip to content

docs: add AGENTS.md with plugin-specific agent guide#85

Merged
JohnMcLear merged 1 commit intomainfrom
chore/add-agents-md
May 9, 2026
Merged

docs: add AGENTS.md with plugin-specific agent guide#85
JohnMcLear merged 1 commit intomainfrom
chore/add-agents-md

Conversation

@JohnMcLear
Copy link
Copy Markdown
Member

Summary

Adds a per-plugin AGENTS.md modeled on etherpad-lite/AGENTS.MD and the canonical ep_align/AGENTS.md. Auto-generated from this repo's ep.json, package.json, and *.js files — please review for accuracy.

Specifically:

  • Tech stack is templated based on which directories exist (templates/, locales/) and whether ep_plugin_helpers is a declared dep.
  • Project structure is a filtered top-level listing (skipping dotfiles, node_modules, lockfiles).
  • Helpers used is grepped from require('ep_plugin_helpers') patterns in *.js.
  • Hooks declared in ep.json is parsed from parts[].hooks and parts[].client_hooks.
  • Helpers NOT used is intentionally left as a placeholder; that's the helpers-adoption sweep (Phase 4).

Part of the fleet-wide plugin docs modernization (pilot: ether/ep_align#182).

Mirrors etherpad-lite/AGENTS.MD shape but scoped to ep_text_statistics:
project structure, helpers used, hooks declared, test commands,
standing rules for agent edits.

Auto-generated from ep.json + package.json + *.js scan; review
the helpers and hooks lists for accuracy before merge.
@qodo-code-review
Copy link
Copy Markdown

ⓘ You've reached your Qodo monthly free-tier limit. Reviews pause until next month — upgrade your plan to continue now, or link your paid account if you already have one.

@JohnMcLear JohnMcLear merged commit 9e77d6a into main May 9, 2026
3 checks passed
@JohnMcLear JohnMcLear deleted the chore/add-agents-md branch May 9, 2026 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant