-
-
Notifications
You must be signed in to change notification settings - Fork 5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Doc] Move CONTRIBUTING to docs site
The `CONTRIBUTING.md` file has some good information for contributors. It would be nice to have a place to organize additional documentation aimed at contributors, so move this content over to the docs site to seed a new `docs/source/contributing` directory. Replace `CONTRIBUTING.md` with a link to the new home for this content. Signed-off-by: Russell Bryant <[email protected]>
- Loading branch information
Showing
3 changed files
with
67 additions
and
58 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,60 +1,3 @@ | ||
# 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 support for a new model. | ||
- Suggest or implement new features. | ||
- Improve documentation or contribute a how-to guide. | ||
|
||
We also believe in the power of community support; thus, answering queries, offering PR reviews, and assisting others are also 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 and highlight how it's driving your incredible projects. Express your support on social media if you're using vLLM, or simply offer your appreciation by starring our repository! | ||
|
||
## License | ||
|
||
See [LICENSE](LICENSE). | ||
|
||
## Developing | ||
|
||
Depending on the kind of development you'd like to do (e.g. Python, CUDA), you can choose to build vLLM with or without compilation. Check out the [building from source](https://docs.vllm.ai/en/latest/getting_started/installation.html#build-from-source) documentation for details. | ||
|
||
## 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. | ||
|
||
## Contribution Guidelines | ||
|
||
### DCO and Signed-off-by | ||
|
||
When contributing changes to this project, you must agree to the [DCO](DCO). | ||
Commits must include a `Signed-off-by:` header which certifies agreement with | ||
the terms of the [DCO](DCO). | ||
|
||
Using `-s` with `git commit` will automatically add this header. | ||
|
||
### Issues | ||
|
||
If you encounter a bug or have a feature request, please [search existing issues](https://github.com/vllm-project/vllm/issues?q=is%3Aissue) first to see if it has already been reported. If not, please [file a new issue](https://github.com/vllm-project/vllm/issues/new/choose), providing as much relevant information as possible. | ||
|
||
> [!IMPORTANT] | ||
> If you discover a security vulnerability, please follow the instructions [here](/SECURITY.md#reporting-a-vulnerability). | ||
### 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. | ||
All of your contributions help make vLLM a great tool and community for everyone! | ||
You may find information about contributing to vLLM on [docs.vllm.ai](https://docs.vllm.ai/en/latest/contributing/overview/). |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# 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 support for a new model. | ||
- Suggest or implement new features. | ||
- Improve documentation or contribute a how-to guide. | ||
|
||
We also believe in the power of community support; thus, answering queries, offering PR reviews, and assisting others are also 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 and highlight how it's driving your incredible projects. Express your support on social media if you're using vLLM, or simply offer your appreciation by starring our repository! | ||
|
||
## License | ||
|
||
See [LICENSE](https://github.com/vllm-project/vllm/tree/main/LICENSE). | ||
|
||
## Developing | ||
|
||
Depending on the kind of development you'd like to do (e.g. Python, CUDA), you can choose to build vLLM with or without compilation. Check out the [building from source](https://docs.vllm.ai/en/latest/getting_started/installation.html#build-from-source) documentation for details. | ||
|
||
## 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. | ||
|
||
## Contribution Guidelines | ||
|
||
### DCO and Signed-off-by | ||
|
||
When contributing changes to this project, you must agree to the [DCO](https://github.com/vllm-project/vllm/tree/main/DCO). | ||
Commits must include a `Signed-off-by:` header which certifies agreement with | ||
the terms of the [DCO](https://github.com/vllm-project/vllm/tree/main/DCO). | ||
|
||
Using `-s` with `git commit` will automatically add this header. | ||
|
||
### Issues | ||
|
||
If you encounter a bug or have a feature request, please [search existing issues](https://github.com/vllm-project/vllm/issues?q=is%3Aissue) first to see if it has already been reported. If not, please [file a new issue](https://github.com/vllm-project/vllm/issues/new/choose), providing as much relevant information as possible. | ||
|
||
> [!IMPORTANT] | ||
> If you discover a security vulnerability, please follow the instructions [here](https://github.com/vllm-project/vllm/tree/main/SECURITY.md#reporting-a-vulnerability). | ||
### Pull Requests & Code Reviews | ||
|
||
Please check the PR checklist in the [PR template](https://github.com/vllm-project/vllm/tree/main/.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. | ||
All of your contributions help make vLLM a great tool and community for everyone! |
This file contains 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