Skip to content

Commit 028298c

Browse files
authored
Add instruction to set up pre-commit hooks. (#1029)
Signed-off-by: Xiongfei Wei <[email protected]>
1 parent 6b8b654 commit 028298c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,17 @@ We choose to follow a similar directory structure as vLLM:
3131
## Testing
3232
When checking in a new feature, we expect that you you add relevant unit tests as well as CI tests. You can read more about the latter [here](https://github.com/vllm-project/tpu-inference/tree/main/.buildkite#adding-a-new-feature-to-ci).
3333

34+
## Setting up linting, formatting, and static type checking
35+
36+
```
37+
pip install pre-commit
38+
39+
# Linting, formatting and static type checking
40+
pre-commit install --hook-type pre-commit --hook-type commit-msg
41+
42+
# You can manually run pre-commit with
43+
pre-commit run --all-files
44+
```
45+
3446
## Thank You!
3547
We wanted to thank you for taking the time to read these guidelines and for your interest in contributing to TPU Inference. All of your contributions help make TPU Infernece a great tool and community for everyone!

0 commit comments

Comments
 (0)