docs: update development setup instructions for uv,HTTPS and SSH#881
Open
joseph-tech-dev wants to merge 1 commit into
Open
docs: update development setup instructions for uv,HTTPS and SSH#881joseph-tech-dev wants to merge 1 commit into
joseph-tech-dev wants to merge 1 commit into
Conversation
- Replace standard pip/venv workflow with - Update git cloning instructions to use SSH and HTTPS - Add installation steps for the package manager
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Author
|
Hello, incase i made a mistake, guide me,kindly. |
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
1 participant
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.
Description
This pull request updates the development setup documentation to transition the project from the legacy
pipandvenvworkflow touv, Astral's fast Python package manager. Additionally, it updates the cloning guidelines to explicitly include both SSH and HTTPS options for contributors.Key changes:
pip/venvsetup workflow with the modern, unifieduv synccommand.uvpackage manager across different operating systems.Type of Change
Related Issues
N/A
Testing
The changes are strictly documentation-focused (
README.md/ development guide updates) and do not alter application logic or test configurations.Checklist
Additional Notes
Adopting
uvlowers the barrier to entry for new contributors by automating Python version management (pinning to 3.11.2 natively) and handling environment isolation seamlessly viauv syncanduv run.