docs: add optional uv-based setup and Windows notes #5325
Conversation
WalkthroughAdded an optional uv-based Python virtual environment setup pathway to CONTRIBUTING.md alongside the existing Poetry instructions; includes pip installation steps, Windows Python-detection caveats, and retains Python 3.11.2 prerequisites. (≈28 words) Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro Knowledge base: Disabled due to 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (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). (2)
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 |
|
👋 Hi @Vanshikadahaliya! This pull request needs a peer review before it can be merged. Please request a review from a team member who is not:
Once a valid peer review is submitted, this check will pass automatically. Thank you! |
📊 Monthly LeaderboardHi @Vanshikadahaliya! Here's how you rank for December 2025:
Leaderboard based on contributions in December 2025. Keep up the great work! 🚀 |
|
CI note: This is a documentation-only change (CONTRIBUTING.md). |
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CONTRIBUTING.md (1)
114-161: Clarify section hierarchy and organization.The
### Python Virtual Environment Setupheader (line 114) has no direct content before the "Optional" subsection begins. The existing Poetry-based setup (starting at line 137) should be explicitly organized as a non-optional baseline or as a subsection. Consider restructuring to make the relationship between the two approaches clear:Option A: Rename line 114 to reflect it covers Poetry, then nest both approaches:
### Python Virtual Environment Setup #### Poetry (Recommended) [existing content from lines 137-161] #### Optional: Using `uv` (Fast Alternative) [uv setup content]Option B: If the current structure is intentional, ensure line 114 explicitly introduces the Poetry workflow as the default before discussing the optional
uvalternative.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
⏰ 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). (2)
- GitHub Check: Run Tests
- GitHub Check: docker-test
|
All requested changes have been addressed and CodeRabbit has approved. |
|
@Vanshikadahaliya It would be quite great if you show how you setup BLT using uv, and show working demo in video / screenshot |
Fixes #3646
This PR documents an optional uv-based Python setup for BLT.
During evaluation, uv was found to have Python discovery limitations
on some Windows environments, which is now documented as well.
Existing Docker and Poetry workflows remain unchanged.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.