From 0e0abeb12309626b3a5cc2db2ffe8cb912d91fa0 Mon Sep 17 00:00:00 2001 From: Chesars Date: Sun, 22 Feb 2026 09:50:26 -0300 Subject: [PATCH] docs(ui): add pre-PR checklist to UI contributing guide Add testing and build verification steps per maintainer feedback from @yjiang-litellm. Contributors should run their related tests per-file and ensure npm run build passes before opening PRs. --- docs/my-website/docs/contributing.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/my-website/docs/contributing.md b/docs/my-website/docs/contributing.md index be7222f6cb..168d092ddc 100644 --- a/docs/my-website/docs/contributing.md +++ b/docs/my-website/docs/contributing.md @@ -79,7 +79,27 @@ cp -r out/* ../../litellm/proxy/_experimental/out/ Then restart the proxy and access the UI at `http://localhost:4000/ui` -## 4. Submitting a PR +## 4. Pre-PR Checklist + +Before submitting your pull request, make sure the following pass locally from `ui/litellm-dashboard/`: + +**Run tests related to your changes:** + +```bash +npx vitest run src/components/path/to/YourComponent.test.tsx +``` + +Tests are co-located with components (e.g., `TeamInfo.tsx` → `TeamInfo.test.tsx`). If you add a new component, add a corresponding `.test.tsx` file next to it. + +**Run the build:** + +```bash +npm run build +``` + +These map to the `ui_tests` and `ui_build` CI checks. + +## 5. Submitting a PR 1. Create a new branch for your changes: ```bash