kanshan/TensorRT-LLMs
1
0
Fork 0
mirror of https://github.com/NVIDIA/TensorRT-LLM.git synced 2026-01-13 22:18:36 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

[None][doc] Update CONTRIBUTING.md (#10023)

Browse Source 
Signed-off-by: Enwei Zhu <21126786+syuoni@users.noreply.github.com>
This commit is contained in:
Enwei Zhu 2025-12-16 18:58:43 +08:00 committed by GitHub
parent 12727ebd7f
commit 6a238ca8ad
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
CONTRIBUTING.md
View File

@ -8,33 +8,9 @@
## Coding Guidelines
* Coding style for TensorRT-LLM can be found [in this document](CODING_GUIDELINES.md).
TensorRT-LLM Coding Style can be found [in this document](CODING_GUIDELINES.md).
* All contributed C++ code should be formatted following the rules in TensorRT-LLM's [clang-format](.clang-format) file. The recommended version is clang-format>=14.0.
* Changes can be formatted with the following command:
```bash
# Commit ID is optional - if unspecified, run format on staged changes.
git-clang-format --style file [commit ID/reference]
```
* All contributed Python code should be formatted using the `black` Python package. The recommended version is `black>=23.0`
* Changes can be formatted with the following command:
```bash
git diff --name-only | grep "*.py" | xargs black -l 120
```
* Try to keep pull requests (PRs) as concise as possible:
* Avoid committing commented-out code.
* Wherever possible, each PR should address a single concern. If there are several otherwise-unrelated things that should be fixed to reach a desired endpoint, our recommendation is to open several PRs and indicate the dependencies in the description. The more complex the changes are in a single PR, the more time it will take to review those changes.
## Coding Style
We use `pre-commit` for automatic code formatting and validation. Install the `pre-commit` package in your local
Python environment.
We use `pre-commit` for automatic code formatting and validation. Install the `pre-commit` package in your local Python environment.
```bash
pip install pre-commit
@ -73,6 +49,9 @@ mdformat.................................................................Passed
If any files were modified by this hook, you will need to stage and commit them again.
In addition, please try to keep pull requests (PRs) as concise as possible:
* Avoid committing commented-out code.
* Wherever possible, each PR should address a single concern. If there are several otherwise-unrelated things that should be fixed to reach a desired endpoint, our recommendation is to open several PRs and indicate the dependencies in the description. The more complex the changes are in a single PR, the more time it will take to review those changes.
## Pull Requests