docs: point CONTRIBUTING at the tooling the repo actually uses - #1665
Conversation
The Code Quality section sends a new contributor to ./PRE_COMMIT.md, which is not in the repository, and then names Black and Prettier as the project's formatters. .pre-commit-config.yaml runs ruff, ruff-format and biome; neither Black nor Prettier is configured anywhere. Replaces the dead link with the install command and the config file itself, so the list of hooks cannot drift out of date again, and corrects the two formatter names.
|
@Yigtwxx is attempting to deploy a commit to the Rohan Verma's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
The job log reports exactly one diagnostic across the whole tree: That file is on A markdown-only PR reaches a TypeScript check because of how the hook is declared in This is not specific to my branch — merged PR #1663 carries the same two failures, and I have opened #1666 with the one-line sort, so it can land independently of this one. Once it does, this PR should go green on a rerun with no changes here. Happy to rebase if you would rather see it green before reviewing. |
The Code Quality section of
CONTRIBUTING.mdsends a new contributor to a file that is not in the repository, and then names two formatters the project does not use.Description
Both problems are in the same twelve lines, which is why they are one PR.
The dead link.
CONTRIBUTING.md:105reads "See our detailed Pre-commit Guide".PRE_COMMIT.mddoes not exist —git ls-fileshas no match, and that line is the only reference to it anywhere in the repo, so it is not a file that moved. This is step 1 of the first section a contributor is told to complete before writing code, so the first instruction in the onboarding path is a 404.The formatter names.
CONTRIBUTING.md:112says "Black for Python, Prettier for TypeScript". Neither is configured:ruff+ruff-format(.pre-commit-config.yaml,[tool.ruff]insurfsense_backend/pyproject.toml)biome(biome.json, run as thebiome-check-webhook)git grep -inE '\bblack\b|prettier' -- '*.toml' '*.json' '*.yaml' '*.yml'returns nothing, so this is not a case of two tools coexisting — the named ones are absent and the real ones are unnamed. The practical cost is a contributor runningblack .on the backend and producing a diff thatruff-formatthen disagrees with.What changed
pip install pre-commit && pre-commit install) and a link to.pre-commit-config.yaml.pip install pre-commitis the same invocation.github/workflows/code-quality.yml:35uses, rather than one invented here.pre-commit run --all-files. Pointing at the config rather than at prose is deliberate: the hook list is then generated from the thing being described and cannot go stale the way the deleted guide did.Black→Ruff,Prettier→Biome.No new documentation file is added. Writing a replacement
PRE_COMMIT.mdwould restore the same failure mode this PR is fixing — a second description of the hooks that drifts from.pre-commit-config.yaml— and choosing to maintain one is a maintainer's call, not something to smuggle into a link repair.Motivation and Context
No linked issue; found while contributing #1660, #1661 and #1662, all of which required reading this section first.
Screenshots
Not applicable — documentation only.
API Changes
Change Type
Testing Performed
One file changed, 3 lines. No code, no tests, nothing executable.
Verified rather than assumed:
PRE_COMMIT.mdabsent:git ls-fileshas no match ondevatcc8fa6e.git grepabove returns nothing across every tracked.toml,.json,.yamland.yml..github/workflows/code-quality.yml:35ispip install pre-commit..pre-commit-config.yamlis at the repository root, alongsideCONTRIBUTING.md.Checklist
High-level PR Summary
This PR fixes documentation errors in
CONTRIBUTING.mdby removing a broken link to a non-existentPRE_COMMIT.mdfile and correcting the formatter tool names from Black/Prettier to the actually configured tools (Ruff/Biome). The dead link is replaced with the actual installation command and a reference to.pre-commit-config.yaml, ensuring contributors can follow working instructions for setting up the development environment.⏱️ Estimated Review Time: 5-15 minutes
💡 Review Order Suggestion
CONTRIBUTING.md