Add pre-commit hook setup instructions to contributing guide#2882
Add pre-commit hook setup instructions to contributing guide#2882
Conversation
|
Warning Rate limit exceeded@koxudaxi has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 27 minutes and 34 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughA new pre-commit hooks installation section was added to the development contributing guide before the existing "Create new branch" step. Two commands ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Pre-merge checks✅ Passed checks (3 passed)
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 |
|
📚 Docs Preview: https://pr-2882.datamodel-code-generator.pages.dev |
CodSpeed Performance ReportMerging #2882 will not alter performanceComparing
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2882 +/- ##
=======================================
Coverage 99.37% 99.37%
=======================================
Files 92 92
Lines 16040 16046 +6
Branches 1893 1893
=======================================
+ Hits 15939 15945 +6
Misses 52 52
Partials 49 49
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/development-contributing.md (1)
32-34: Consider adding context about what pre-commit hooks do.prek is a Rust-based reimplementation of pre-commit, designed to be a faster, dependency-free and drop-in alternative. The section could benefit from a brief explanation of why contributors need to set up pre-commit hooks—for instance, that they automatically run code quality checks before commits.
You might also mention that this requires a
.pre-commit-config.yamlfile in the repository that defines which hooks are configured.🔎 Suggested enhancement
~## 5. Install pre-commit hooks +## 5. Install pre-commit hooks + +Pre-commit hooks automatically run code quality checks before commits. + ~$ uv tool install prek ~$ prek install
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/development-contributing.md
⏰ 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). (15)
- GitHub Check: py312-isort6 on Ubuntu
- GitHub Check: py312-isort7 on Ubuntu
- GitHub Check: 3.14 on Ubuntu
- GitHub Check: 3.10 on Ubuntu
- GitHub Check: 3.10 on Windows
- GitHub Check: 3.12 on Windows
- GitHub Check: 3.11 on Ubuntu
- GitHub Check: 3.11 on Windows
- GitHub Check: py312-pydantic1 on Ubuntu
- GitHub Check: py312-isort5 on Ubuntu
- GitHub Check: py312-black22 on Ubuntu
- GitHub Check: 3.14 on Windows
- GitHub Check: 3.13 on Windows
- GitHub Check: Analyze (python)
- GitHub Check: benchmarks
🔇 Additional comments (1)
docs/development-contributing.md (1)
36-52: Step numbering is consistent and correct.The sequential step numbers have been properly incremented throughout to accommodate the new pre-commit hooks installation step.
Breaking Change AnalysisResult: No breaking changes detected Reasoning: PR #2882 only modifies the documentation file This analysis was performed by Claude Code Action |
|
🎉 Released in 0.51.0 This PR is now available in the latest release. See the release notes for details. |
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.