Walkthrough
Replaces references to pre-commit with prek across the contributing guide: installation steps, hook installation and execution, command invocations, headings, failing-check messaging, and the Before Submitting workflow; pytest workflow separation unchanged.
Changes
| Cohort / File(s) | Summary |
|---|---|
Documentation terminology update docs/development/contributing.mdx |
Replaced pre-commit references with prek across installation instructions, hook setup and execution, command examples (e.g., uv run prek install, uv run prek run --all-files), section headings (e.g., "Pre-commit hooks" β "Prek hooks", "Pre-Commit Checks" β "Prek Checks"), failing-check messaging, and submission steps. |
Poem
π° The prek hops in, fresh and spry,
Old hooks step back with a wink of an eye,
Commands rebloom, now tidy and neat,
Docs skip along on nimble feet,
A rabbit's little hopβclean, swift, complete.
Pre-merge checks and finishing touches
β Failed checks (2 warnings)| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Description Check | β οΈ Warning | The PR description provides a clear and detailed narrative about the changes, including what was modified, why the migration is beneficial, and confirmation of local testing. However, the description is missing critical sections from the required template: the entire Contributors Checklist (with items about issue closure, workflow adherence, testing, and documentation updates) and the Review Checklist (with self-review confirmation). While the author has addressed these topics informally in their description, they have not followed the structured template format with the required checkbox verification sections. | The description should be updated to include the missing Contributors Checklist and Review Checklist sections with all required checkboxes completed. The author should explicitly check off each item confirming they have followed the development workflow, tested the changes, updated documentation, performed self-review, and are ready for review. |
| Docstring Coverage | β οΈ Warning | Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. | You can run @coderabbitai generate docstrings to improve docstring coverage. |
| Check name | Status | Explanation |
|---|---|---|
| Title Check | β Passed | The pull request title "switch from pre-commit to prek" directly and accurately summarizes the main change in the changeset. The raw summary confirms the changes are focused on replacing pre-commit references with prek throughout the documentation, and the title is concise, specific, and avoids vague terminology. A teammate scanning the commit history would immediately understand that this is a tool migration from pre-commit to prek. |
- Create PR with unit tests
- Post copyable unit tests in a comment
- Commit unit tests in branch
switch-to-prek
π Recent review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
π₯ CommitsReviewing files that changed from the base of the PR and between 2727f25 and f10858b .
π Files selected for processing (1)docs/development/contributing.mdx(3 hunks)
π CodeRabbit inference engine (docs/.cursor/rules/mintlify.mdc)
docs/**/*.mdx: Use clear, direct language appropriate for technical audiences
Write instructions and procedures in second person ("you")
Use active voice over passive voice
Use present tense for current states and future tense for outcomes
Maintain consistent terminology across the documentation
Keep sentences concise while preserving necessary context
Use parallel structure in lists, headings, and procedures
Lead with the most important information (inverted pyramid)
Use progressive disclosure: basic concepts before advanced ones
Break complex procedures into numbered steps
Include prerequisites and context before instructions
Provide expected outcomes for each major step
End sections with next steps or related information
Use descriptive, keyword-rich headings for navigation and SEO
Focus on user goals and outcomes rather than system features
Anticipate common questions and address them proactively
Include troubleshooting for likely failure points
Offer multiple pathways when appropriate (beginner vs advanced) and provide an opinionated recommended path
Use for supplementary information that supports the main content
Use for expert advice, shortcuts, or best practices
Use for critical cautions, breaking changes, or destructive actions
Use for neutral background or contextual information
Use to confirm success or completion
Provide single code examples using fenced code blocks with language (and filename when relevant)
Use to present the same concept in multiple languages
For API docs, use to show requests
For API docs, use to show responses
Use and to document procedures and sequential instructions
Use and for platform-specific or alternative approaches
Use / for supplementary content that might interrupt flow
In API docs, use for parameters (path, body, query, header) with type and required/default as appropria...
Files:
docs/development/contributing.mdx
π CodeRabbit inference engine (AGENTS.md)
docs/**/*.{md,mdx}: Documentation code examples should be explained before the code and be fully runnable, including imports
Use clear headers with logical H2/H3 hierarchy to form navigation
Write user-focused content that motivates the why before the how
Prefer prose for important information over code comments in docs
Files:
docs/development/contributing.mdx
π CodeRabbit inference engine (AGENTS.md)
**/*.{md,mdx}: Be brief and to the point in written materials; avoid regurgitating obvious code details
Avoid defensive constructions like "This isn't X" or "Not just X, but Y"; state what it is directly
Files:
docs/development/contributing.mdx
Learnt from: CR
Repo: jlowin/fastmcp PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-27T14:40:00.422Z
Learning: Run uv sync, pre-commit (Ruff + Prettier + ty), and pytest in sequence before committing; all must pass
Learnt from: CR
Repo: jlowin/fastmcp PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-27T14:40:00.422Z
Learning: Run uv sync, pre-commit (Ruff + Prettier + ty), and pytest in sequence before committing; all must pass
Applied to files:
docs/development/contributing.mdx
[grammar] ~115-~115: Ensure spelling is correct
Context: ...ately as a distinct workflow step after prek checks pass. CI will reject PRs that fai...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
β° Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)- GitHub Check: Run tests: Python 3.10 on ubuntu-latest
- GitHub Check: Run tests with lowest-direct dependencies
- GitHub Check: Run tests: Python 3.10 on windows-latest
docs/development/contributing.mdx (4)
52-58: Installation steps correctly updated to prek.The transition from pre-commit to prek is consistent here, and the message about hooks running automatically remains appropriate.
110-115: Tool list and pytest separation now correct.The previous review flagged an incorrect prek tools list; this version now correctly includes Prettier and explicitly notes that Pytest runs as a separate workflow step. This aligns with the documented pre-commit configuration (Ruff, Prettier, ty) and the project's development workflow.
158-158: Before Submitting step correctly runs both prek and pytest.The command properly chains prek checks with pytest execution, maintaining the required workflow.
1-162: Migration from pre-commit to prek is comprehensive and well-executed.The changes consistently replace pre-commit references with prek throughout the contributing guide. The tool list has been corrected from the previous review feedback (Prettier is now included, Pytest properly noted as separate), and all commands properly use
uv run prek ...for consistency with the project's tooling. The Before Submitting workflow correctly chains both prek and pytest execution.To ensure completeness of the migration across all documentation, please verify that the changes to AGENTS.md and README.md (mentioned in the PR summary) are similarly consistent and don't contain any residual pre-commit references.
Comment @coderabbitai help to get the list of available commands and usage tips.