Repository navigation
docs(contributing): remove stale .eslintrc.json and test references - #575
Open
Ankit-matrix wants to merge 1 commit into
Open
Ankit-matrix wants to merge 1 commit into
Ankit-matrix wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
🟢 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Two small cleanups in
CONTRIBUTING.md:[style]link reference pointing at.eslintrc.json.from the pull-request checklist.
Why
[style]reference → nonexistent file. The repo moved to ESLint 9flat config in #480, which added
eslint.config.jsandeslint.config.mjs; there is no.eslintrc.jsononmainanymore, sothe reference 404s. It is also never used anywhere in the body of
CONTRIBUTING.md, so the removal has no visible effect — it just stopsleaking 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 inpackage.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 testwas already removed in
e86b689("chore(contributing): remove missingtest 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 onmain.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.