-
-
Notifications
You must be signed in to change notification settings - Fork 3k
.pr_agent_accepted_suggestions
| PR 7348 (2026-03-04) |
[reliability] Node version mismatch
Node version mismatch
AGENTS.MD declares Node.js >=20.0.0, but README.md and src/package.json state >=18.18.2, while the root package.json enforces >=20.0.0; this inconsistency will confuse contributors and can lead to setup failures depending on which source they follow.AGENTS.MD states Node.js >=20.0.0, but README.md and src/package.json indicate Node.js >=18.18.2 while the root package.json enforces >=20.0.0. This creates conflicting guidance and can cause contributor setup failures.
The repo currently has multiple stated Node minimums. AGENTS.MD should not add another competing requirement; it should either align with the project-wide requirement or clearly explain why different parts of the repo have different engine constraints.
- AGENTS.MD[8-11]
- README.md[101-114]
- package.json[44-46]
- src/package.json[125-129]
[correctness] Wrong easysync doc path
Wrong easysync doc path
AGENTS.MD tells contributors to consult `doc/easysync/`, but the easysync docs checked into this repo are under `doc/public/easysync/`. This will send contributors to a dead-end location when working on synchronization logic.AGENTS.MD references a non-existent/inaccurate easysync documentation path (doc/easysync/). The easysync materials in this repository live under doc/public/easysync/.
This is onboarding-critical documentation; wrong paths cause contributors to waste time when touching Easysync.
- AGENTS.MD[51-53]
[correctness] README hides Node>=20 req
README hides Node>=20 req
README’s Requirements section no longer states a minimum Node.js version, but the repo enforces Node >=20 (engineStrict + runtime check). Users following the README may install an unsupported Node version and hit install/runtime failures.README no longer specifies a minimum Node.js version, but the repo enforces Node >= 20.0.0 at install time (engineStrict) and at runtime (startup exits if Node is too old). This mismatch will cause avoidable setup failures for new users.
- Root
package.jsonsetsengines.nodeto>=20.0.0andengineStrict: true. -
src/node/server.tsenforces the minimum based onsrc/package.json.
- README.md[101-105]
- package.json[44-52]
- src/package.json[125-129]
[reliability] HTML indent rule conflicts
HTML indent rule conflicts
AGENTS.MD mandates 4-space HTML indentation, but .editorconfig sets indent_size=2 globally with no HTML override; contributors using EditorConfig-aware tools will format HTML with 2 spaces, causing noisy diffs and review churn.AGENTS.MD says HTML should be indented with 4 spaces, but .editorconfig enforces indent_size=2 for all files. EditorConfig-aware tools will format HTML with 2 spaces, leading to inconsistent formatting and PR churn.
CONTRIBUTING.md also says HTML is 4 spaces, so the inconsistency likely predates this PR; however, adding AGENTS.MD amplifies the mismatch. Decide which rule is correct and make the documentation and tooling consistent.
- AGENTS.MD[30-33]
- .editorconfig[1-20]
- CONTRIBUTING.md[83-90]
[correctness] Misleading tests directory
Misleading tests directory
AGENTS.MD lists a top-level `tests/` directory, but the test suites live under `src/tests/` (and scripts reference `tests/...` relative to `src/`). This can confuse contributors when locating tests and test docs from the repo root.AGENTS.MD claims a repo-root tests/ directory, but tests are located under src/tests/ (repo-root path). Some scripts use tests/... paths relative to src/, which is easy to misinterpret.
Contributors reading AGENTS.MD from the repo root will likely search for ./tests and not find the test documentation.
- AGENTS.MD[17-26]
[reliability] Plugin tooling Node floor stale
Plugin tooling Node floor stale
Core now declares Node >=20 in `src/package.json`, but the plugin checker still writes `engines.node: >=18.0.0` into plugin package.json files. This can mislead plugin authors into thinking Node 18 is a supported baseline for current Etherpad development.After bumping core’s Node requirement to >=20, the plugin checker still stamps plugins with engines.node >=18.0.0, which is inconsistent with the runtime users will actually run plugins under. This is likely to confuse plugin authors and create avoidable incompatibility reports.
- Core requires Node >=20 (root and src package manifests; CI matrix).
-
bin/plugins/checkPlugin.tscurrently writes>=18.0.0into pluginpackage.json.
- bin/plugins/checkPlugin.ts[229-233]
- package.json[44-46]
- src/package.json[125-129]
[correctness] Wrong easysync doc path
Wrong easysync doc path
AGENTS.MD tells contributors to consult `doc/easysync/`, but the easysync docs checked into this repo are under `doc/public/easysync/`. This will send contributors to a dead-end location when working on synchronization logic.AGENTS.MD references a non-existent/inaccurate easysync documentation path (doc/easysync/). The easysync materials in this repository live under doc/public/easysync/.
This is onboarding-critical documentation; wrong paths cause contributors to waste time when touching Easysync.
- AGENTS.MD[51-53]
[correctness] Backend runner misstated
Backend runner misstated
AGENTS.MD lists Vitest as a primary testing tool, but the default backend test command uses Mocha (Vitest exists as a separate script). This can lead contributors to run the wrong tool when validating backend changes.AGENTS.MD describes the test stack as primarily Vitest, but the default backend test runner is Mocha.
Contributors may attempt to use Vitest for backend tests and fail to run the actual CI-equivalent suite.
- AGENTS.MD[8-16]
[reliability] Node version mismatch
Node version mismatch
AGENTS.MD declares Node.js >=20.0.0, but README.md and src/package.json state >=18.18.2, while the root package.json enforces >=20.0.0; this inconsistency will confuse contributors and can lead to setup failures depending on which source they follow.AGENTS.MD states Node.js >=20.0.0, but README.md and src/package.json indicate Node.js >=18.18.2 while the root package.json enforces >=20.0.0. This creates conflicting guidance and can cause contributor setup failures.
The repo currently has multiple stated Node minimums. AGENTS.MD should not add another competing requirement; it should either align with the project-wide requirement or clearly explain why different parts of the repo have different engine constraints.
- AGENTS.MD[8-11]
- README.md[101-114]
- package.json[44-46]
- src/package.json[125-129]
[correctness] Misleading tests directory
Misleading tests directory
AGENTS.MD lists a top-level `tests/` directory, but the test suites live under `src/tests/` (and scripts reference `tests/...` relative to `src/`). This can confuse contributors when locating tests and test docs from the repo root.AGENTS.MD claims a repo-root tests/ directory, but tests are located under src/tests/ (repo-root path). Some scripts use tests/... paths relative to src/, which is easy to misinterpret.
Contributors reading AGENTS.MD from the repo root will likely search for ./tests and not find the test documentation.
- AGENTS.MD[17-26]
- Docs
- Translating
- HTTP API
- Plugin framework (API hooks)
- Plugins (available)
- Plugins (list)
- Plugins (wishlist)
- Etherpad URIs / URLs to specific resources IE export
- Etherpad Full data export
- Introduction to the source
- Release Procedure
- Etherpad Developer guidelines
- Project to-do list
- Changeset Library documentation
- Alternative Etherpad-Clients
- Contribution guidelines
- Installing Etherpad
- Deploying Etherpad as a service
- Deploying Etherpad on CloudFoundry
- Deploying Etherpad on Heroku
- Running Etherpad on Phusion Passenger
- Putting Etherpad behind a reverse Proxy (HTTPS/SSL)
- How to setup Etherpad on Ubuntu 12.04 using Ansible
- Migrating from old Etherpad to Etherpad
- Using Etherpad with MySQL
- Customizing the Etherpad web interface
- Enable import/export functionality with AbiWord
- Getting a list of all pads
- Providing encrypted web access to Etherpad using SSL certificates
- Optimizing Etherpad performance including faster page loads
- Getting to know the tools and scripts in the Etherpad /bin/ folder
- Embedding a pad using the jQuery plugin
- Using Embed Parameters
- Integrating Etherpad in a third party app (Drupal, MediaWiki, WordPress, Atlassian, PmWiki)
- HTTP API client libraries