Skip to content

docs: add uv prerequisites to bot readme#341

Merged
qin-ctx merged 1 commit intovolcengine:mainfrom
Tsan1024:main
Feb 28, 2026
Merged

docs: add uv prerequisites to bot readme#341
qin-ctx merged 1 commit intovolcengine:mainfrom
Tsan1024:main

Conversation

@Tsan1024
Copy link
Contributor

@Tsan1024 Tsan1024 commented Feb 28, 2026

Description

Update the README document of the bot module to add the prerequisites for installing and using the uv tool (Python package/environment management tool), clarifying the installation steps and usage scenarios of uv in the project environment setup process, helping developers quickly complete the environment configuration.

Related Issue

None (documentation optimization for developer experience)

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test update

Changes Made

  • Add the installation steps of uv tool (covering Linux/Mac/Windows systems) in the bot module README
  • Supplement the usage example of uv venv --python 3.11 for creating a virtual environment in the environment setup section

Testing

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested this on the following platforms:
    • Linux
    • macOS
    • Windows

Checklist

  • My code follows the project's coding style
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Screenshots (if applicable)

image

Additional Notes

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@qin-ctx qin-ctx merged commit 91a5cb4 into volcengine:main Feb 28, 2026
1 check was pending
@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenViking project Feb 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants