mirror of
https://git.datalinker.icu/vllm-project/vllm.git
synced 2025-12-10 01:35:01 +08:00
57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
# Contributing to vLLM
|
|
|
|
Thank you for your interest in contributing to vLLM!
|
|
Our community is open to everyone and welcomes all kinds of contributions, no matter how small or large.
|
|
There are several ways you can contribute to the project:
|
|
|
|
- Identify and report any issues or bugs.
|
|
- Request or add a new model.
|
|
- Suggest or implement new features.
|
|
|
|
However, remember that contributions aren't just about code.
|
|
We believe in the power of community support; thus, answering queries, assisting others, and enhancing the documentation are highly regarded and beneficial contributions.
|
|
|
|
Finally, one of the most impactful ways to support us is by raising awareness about vLLM.
|
|
Talk about it in your blog posts, highlighting how it's driving your incredible projects.
|
|
Express your support on Twitter if vLLM aids you, or simply offer your appreciation by starring our repository.
|
|
|
|
|
|
## Setup for development
|
|
|
|
### Build from source
|
|
|
|
```bash
|
|
pip install -e . # This may take several minutes.
|
|
```
|
|
|
|
### Testing
|
|
|
|
```bash
|
|
pip install -r requirements-dev.txt
|
|
|
|
# linting and formatting
|
|
bash format.sh
|
|
# Static type checking
|
|
mypy
|
|
# Unit tests
|
|
pytest tests/
|
|
```
|
|
**Note:** Currently, the repository does not pass the mypy tests.
|
|
|
|
|
|
## Contributing Guidelines
|
|
|
|
### Issue Reporting
|
|
|
|
If you encounter a bug or have a feature request, please check our issues page first to see if someone else has already reported it.
|
|
If not, please file a new issue, providing as much relevant information as possible.
|
|
|
|
### Pull Requests & Code Reviews
|
|
|
|
Please check the PR checklist in the [PR template](.github/PULL_REQUEST_TEMPLATE.md) for detailed guide for contribution.
|
|
|
|
### Thank You
|
|
|
|
Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM.
|
|
Your contributions make vLLM a great tool for everyone!
|