forked from phoenix/litellm-mirror
docs(code_quality.md): add doc on litellm code qa
This commit is contained in:
parent
e19bb55e3b
commit
121b493fe8
2 changed files with 13 additions and 0 deletions
12
docs/my-website/docs/extras/code_quality.md
Normal file
12
docs/my-website/docs/extras/code_quality.md
Normal file
|
@ -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.
|
|
@ -306,6 +306,7 @@ const sidebars = {
|
||||||
"migration_policy",
|
"migration_policy",
|
||||||
"contributing",
|
"contributing",
|
||||||
"proxy/pii_masking",
|
"proxy/pii_masking",
|
||||||
|
"extras/code_quality",
|
||||||
"rules",
|
"rules",
|
||||||
"proxy_server",
|
"proxy_server",
|
||||||
{
|
{
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue