Skip to content

docs(contributing): remove stale .eslintrc.json and test references - #575

Open
Ankit-matrix wants to merge 1 commit into
github:mainfrom
Ankit-matrix:main
Open

Ankit-matrix wants to merge 1 commit into
github:mainfrom
Ankit-matrix:main

Conversation

@Ankit-matrix

Copy link
Copy Markdown

What

Two small cleanups in CONTRIBUTING.md:

  1. Remove the orphan [style] link reference pointing at .eslintrc.json.
  2. Drop the "add tests, and make sure the tests ... still pass" instruction
    from the pull-request checklist.

Why

[style] reference → nonexistent file. The repo moved to ESLint 9
flat config in #480, which added eslint.config.js and
eslint.config.mjs; there is no .eslintrc.json on main anymore, so
the reference 404s. It is also never used anywhere in the body of
CONTRIBUTING.md, so the removal has no visible effect — it just stops
leaking a broken link. #363 fixed the sibling broken links in this file
but did not touch this one.

Test instructions → no test infrastructure exists. There is no
"test" script in package.json, no test runner in dependencies
(Jest / Vitest / Mocha / Playwright / Testing Library), no test files
anywhere in the tree, and the pre-commit hook only runs npm run lint.
The companion step Make sure the tests pass on your machine: npm run test
was already removed in e86b689 ("chore(contributing): remove missing
test script reference") for the same reason — this sentence is the
leftover.

New contributors who follow the checklist today are asked to run and
pass tests that do not exist.

How this was checked

  • grep -n "eslintrc" . — only match is the removed line.
  • ls .eslintrc* — no such file on main.
  • grep -E '"test"|jest|vitest|mocha|cypress|playwright|@testing-library' package.json — no matches.
  • find . -name '*.test.*' -o -name '*.spec.*' -o -name '__tests__' — no results.
  • npm run lint — passes.
  • npx prettier --check CONTRIBUTING.md — passes.

Copilot AI adaptive review requested due to automatic review settings November 15, 2026 20:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues remain in the documentation-only changes, which remove obsolete guidance while retaining the current linting requirement.

No open issues 🎉

What changed in this PR

This documentation-only PR updates contribution guidance to match the repository’s current tooling.

Changes:

  • Removes the unused link to the nonexistent .eslintrc.json.
  • Removes obsolete instructions to add and run tests when no test infrastructure exists.
  • Retains the existing linting requirement.
File Description
CONTRIBUTING.md Removes the broken ESLint configuration reference and outdated test-related checklist instructions.

Review effort: Lite (dynamic)

This branch has not been deployed

No deployments
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