From 41f7901cfaf39780909c0307bcb5ce5a035a34bc Mon Sep 17 00:00:00 2001 From: Krrish Dholakia Date: Thu, 14 Aug 2025 17:15:29 -0700 Subject: [PATCH] docs(readme.md): add note, saying poetry is required --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 64a44f5bcb..319077ba91 100644 --- a/README.md +++ b/README.md @@ -374,6 +374,12 @@ We welcome contributions to LiteLLM! Whether you're fixing bugs, adding features ## Quick Start for Contributors +:::info + +This requires poetry to be installed. + +::: + ```bash git clone https://github.com/BerriAI/litellm.git cd litellm @@ -381,6 +387,7 @@ make install-dev # Install development dependencies make format # Format your code make lint # Run all linting checks make test-unit # Run unit tests +make format-check # Check formatting only ``` For detailed contributing guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md). @@ -396,11 +403,6 @@ Our automated checks include: - **Circular import detection** - **Import safety checks** -Run all checks locally: -```bash -make lint # Run all linting (matches CI) -make format-check # Check formatting only -``` All these checks must pass before your PR can be merged.