From f4b5a491b65e331c3a42f77256cf6e8277474c24 Mon Sep 17 00:00:00 2001 From: Krish Dholakia Date: Tue, 10 Dec 2024 15:44:59 -0800 Subject: [PATCH] docs: document code quality (#7149) * docs: document code quality * build(readme.md): cleanup --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 41bb75619951..fa16bfa3e326 100644 --- a/README.md +++ b/README.md @@ -349,6 +349,20 @@ This covers: - ✅ **Custom SLAs** - ✅ **Secure access with Single Sign-On** +# Code Quality / Linting + +LiteLLM follows the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html). + +We run: +- Ruff for [formatting and linting checks](https://github.com/BerriAI/litellm/blob/e19bb55e3b4c6a858b6e364302ebbf6633a51de5/.circleci/config.yml#L320) +- Mypy + Pyright for typing [1](https://github.com/BerriAI/litellm/blob/e19bb55e3b4c6a858b6e364302ebbf6633a51de5/.circleci/config.yml#L90), [2](https://github.com/BerriAI/litellm/blob/e19bb55e3b4c6a858b6e364302ebbf6633a51de5/.pre-commit-config.yaml#L4) +- Black for [formatting](https://github.com/BerriAI/litellm/blob/e19bb55e3b4c6a858b6e364302ebbf6633a51de5/.circleci/config.yml#L79) +- isort for [import sorting](https://github.com/BerriAI/litellm/blob/e19bb55e3b4c6a858b6e364302ebbf6633a51de5/.pre-commit-config.yaml#L10) + + +If you have suggestions on how to improve the code quality feel free to open an issue or a PR. + + # Support / talk with founders - [Schedule Demo 👋](https://calendly.com/d/4mp-gd3-k5k/berriai-1-1-onboarding-litellm-hosted-version)