Skip to content

chore(root): drop three redundant top-level files#7839

Merged
JohnMcLear merged 2 commits into
developfrom
chore/tidy-root
May 25, 2026
Merged

chore(root): drop three redundant top-level files#7839
JohnMcLear merged 2 commits into
developfrom
chore/tidy-root

Conversation

@JohnMcLear

Copy link
Copy Markdown
Member

Summary

Quick tidy-up of the project root so a new contributor lands on fewer ambiguous files. Three changes, no CI or build wiring touched:

  • Delete best_practices.md — duplicate of CONTRIBUTING.md. The two unique rules (PRs MUST include a description; flag empty descriptions as incomplete) are merged into CONTRIBUTING.md in the same commit.
  • Delete .pr_agent.toml — Qodo PR-bot config with no functional refs in the repo; Qodo is not currently reviewing this repo.
  • Delete root tests symlink (→ src/tests) — Verified nothing relies on the root-relative path:
    • GitHub workflows all use src/tests/...
    • bin/ scripts use the ep_etherpad-lite/tests/... package path
    • src/playwright.config.ts testDir is src/
    • src/.eslintrc.cjs patterns are relative to src/

Root entry count drops 35 → 32. Larger reorgs (moving settings.json.template, settings.json.docker, docker-compose.*, etc.) are intentionally out of scope — those touch many CI workflows and external user expectations and deserve their own discussion.

Test plan

  • CI passes (no test changes required; this is doc/dotfile-only)
  • Spot-check git grep best_practices, git grep pr_agent, and root-relative tests/ patterns turn up only historical refs in docs/superpowers/

Three small clean-ups to make the project root easier to scan for new
contributors:

- best_practices.md was a near-duplicate of CONTRIBUTING.md. Merge its
  two unique bullets (PRs MUST include a description / flag empty
  descriptions as incomplete) into CONTRIBUTING.md and remove the file.
- .pr_agent.toml is a two-line Qodo PR-bot config. It has no functional
  references in the repo and Qodo currently doesn't review this repo.
- tests/ -> src/tests was an unused root symlink. Verified no workflow,
  script, eslint config, or playwright config relies on the root path
  (all callers use src/tests/... or the ep_etherpad-lite package path).

No CI, build, or docs updates needed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Review Summary by Qodo

Clean up redundant root-level files and documentation

Grey Divider

Walkthroughs

Description
• Delete redundant best_practices.md file, merging unique content into CONTRIBUTING.md
• Remove unused .pr_agent.toml Qodo PR-bot configuration file
• Delete root-level tests symlink pointing to src/tests
• Add PR description requirements to CONTRIBUTING.md
Diagram
flowchart LR
  A["Root Directory"] -->|"Delete best_practices.md"| B["CONTRIBUTING.md"]
  A -->|"Merge PR rules"| B
  A -->|"Delete .pr_agent.toml"| C["Removed"]
  A -->|"Delete tests symlink"| D["Removed"]
  B -->|"Updated with PR requirements"| E["Enhanced Guidelines"]

Loading

File Changes

1. best_practices.md 📝 Documentation +0/-132

Delete duplicate best practices file

• File completely deleted (132 lines removed)
• Duplicate of CONTRIBUTING.md with overlapping content
• Two unique PR rules merged into CONTRIBUTING.md

best_practices.md


2. CONTRIBUTING.md 📝 Documentation +2/-0

Add PR description requirements

• Added two new PR requirements at the top of Pull requests section
• "PRs MUST include a non-empty description explaining what the change does and why"
• "PRs without a description should be flagged as incomplete"
• Content merged from deleted best_practices.md

CONTRIBUTING.md


3. .pr_agent.toml ⚙️ Configuration changes +0/-5

Remove unused Qodo PR-bot config

• File completely deleted (5 lines removed)
• Qodo PR-bot configuration with no functional references in repo
• Qodo currently does not review this repository

.pr_agent.toml


View more (1)
4. tests Miscellaneous +0/-1

Delete unused root tests symlink

• Symlink deleted (pointed to src/tests)
• Verified no workflows, scripts, or configs rely on root-relative path
• All callers use src/tests/... or package path ep_etherpad-lite/tests/...

tests


Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented May 25, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider


Action required

1. tests symlink removal undocumented ✓ Resolved 📘 Rule violation ⚙ Maintainability
Description
The PR deletes the root tests symlink, but CONTRIBUTING.md still instructs contributors to find
front-end tests under tests/frontend/, which will no longer exist and misleads new contributors.
This violates the requirement to update documentation alongside user-facing project structure
changes, as the tests now live under src/tests/frontend/ and the contributing guide must reflect
that actual path.
Code

tests[1]

Evidence
CONTRIBUTING.md currently documents the old root-level tests/frontend/ location, but with the
root tests entry removed by this PR, that path becomes dead. Other contributor docs and the
repository layout already place tests under src/tests/..., making CONTRIBUTING.md internally
inconsistent with the actual test location and misleading to new contributors.

CONTRIBUTING.md[127-130]
bin/plugins/lib/CONTRIBUTING.md[115-121]
CONTRIBUTING.md[127-131]
src/tests/README.md[1-12]
Best Practice: Repository guidelines

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The root `tests` symlink is removed by this PR, but contributor documentation still references `tests/frontend/` as the location of front-end tests, making it a dead path that will mislead new contributors.
## Issue Context
Tests live under `src/tests/...` (and other docs already reflect that), so all references to `tests/frontend/` in contributor guides should be updated to point to `src/tests/frontend/` instead.
## Fix Focus Areas
- CONTRIBUTING.md[127-131]
- bin/plugins/lib/CONTRIBUTING.md[115-121]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Advisory comments

2. Stale best_practices mention ✓ Resolved 🐞 Bug ⚙ Maintainability
Description
A design doc under docs/ still cites best_practices.md as a policy source even though this PR
deletes that file. Readers will be left with misleading documentation and an implied policy
reference that no longer exists.
Code

best_practices.md[L1-12]

Evidence
The referenced design doc explicitly names best_practices.md as part of the project's policy set,
but this PR removes best_practices.md from the repo.

docs/superpowers/specs/2026-05-08-issue-7693-admin-openapi-design.md[189-202]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`best_practices.md` is deleted, but at least one in-repo doc still references it as an authoritative policy document.
## Issue Context
The policy appears to live in `CONTRIBUTING.md` / `AGENTS.MD` now, so the reference should be removed or replaced.
## Fix Focus Areas
- docs/superpowers/specs/2026-05-08-issue-7693-admin-openapi-design.md[198-201]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

Comment thread tests
@JohnMcLear JohnMcLear requested a review from SamTV12345 May 25, 2026 12:20
Follow-up on Qodo review feedback for #7839:

- CONTRIBUTING.md: front-end-tests path now reads src/tests/frontend/
  instead of the dead tests/frontend/ (the root tests symlink is gone).
  The browser URL <yourdomainhere>/tests/frontend stays — that's an
  Express route served by the test runner, not a filesystem path.
- docs/superpowers/specs/...openapi-design.md: drop best_practices.md
  from the parenthetical list of policy sources (now CONTRIBUTING.md
  and AGENTS.MD), since best_practices.md has been removed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@SamTV12345

Copy link
Copy Markdown
Member

Why is now qodo not reviewing the repository? Besides that looks good.

@SamTV12345 SamTV12345 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned only thing being a bit striking is this qodo thing. But could be that I don't have the full picture. Looks like qodo is still working.

@JohnMcLear JohnMcLear merged commit 4b30653 into develop May 25, 2026
32 checks passed
@JohnMcLear JohnMcLear deleted the chore/tidy-root branch May 25, 2026 14:15
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.

2 participants