From 121b493fe815d96bb0e5ba9e3890f3b81f8ff8a0 Mon Sep 17 00:00:00 2001 From: Krrish Dholakia Date: Wed, 2 Oct 2024 11:20:15 -0400 Subject: [PATCH] docs(code_quality.md): add doc on litellm code qa --- docs/my-website/docs/extras/code_quality.md | 12 ++++++++++++ docs/my-website/sidebars.js | 1 + 2 files changed, 13 insertions(+) create mode 100644 docs/my-website/docs/extras/code_quality.md diff --git a/docs/my-website/docs/extras/code_quality.md b/docs/my-website/docs/extras/code_quality.md new file mode 100644 index 000000000..81b72a76d --- /dev/null +++ b/docs/my-website/docs/extras/code_quality.md @@ -0,0 +1,12 @@ +# Code Quality + +🚅 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. diff --git a/docs/my-website/sidebars.js b/docs/my-website/sidebars.js index c3c5bd315..5920b8841 100644 --- a/docs/my-website/sidebars.js +++ b/docs/my-website/sidebars.js @@ -306,6 +306,7 @@ const sidebars = { "migration_policy", "contributing", "proxy/pii_masking", + "extras/code_quality", "rules", "proxy_server", {