Skip to content

Comments

docs(ui): add pre-PR checklist to UI contributing guide#21886

Open
Chesars wants to merge 1 commit intoBerriAI:mainfrom
Chesars:docs/ui-contributing-pre-pr-checklist
Open

docs(ui): add pre-PR checklist to UI contributing guide#21886
Chesars wants to merge 1 commit intoBerriAI:mainfrom
Chesars:docs/ui-contributing-pre-pr-checklist

Conversation

@Chesars
Copy link
Contributor

@Chesars Chesars commented Feb 22, 2026

Relevant issues

Follow-up to #19353 — incorporates maintainer feedback from @yjiang-litellm on the UI contributing guide.

Pre-Submission checklist

  • I have Added testing in the tests/litellm/ directory, Adding at least 1 test is a hard requirement - see details
  • My PR passes all unit tests on make test-unit
  • My PR's scope is as isolated as possible, it only solves 1 specific problem

Type

📖 Documentation

Changes

Adds a Pre-PR Checklist section (Section 4) to the UI contributing guide (docs/my-website/docs/contributing.md) per feedback from @yjiang-litellm:

  • Run related tests per-file: npx vitest run src/components/path/to/YourComponent.test.tsx
  • Run the build: npm run build
  • Notes that these map to the ui_tests and ui_build CI checks

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.
@vercel
Copy link

vercel bot commented Feb 22, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
litellm Ready Ready Preview, Comment Feb 22, 2026 0:53am

Request Review

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 22, 2026

Greptile Summary

This PR adds a Pre-PR Checklist section (Section 4) to the UI contributing guide (docs/my-website/docs/contributing.md), incorporating maintainer feedback from issue #19353. The new section instructs contributors to:

  • Run component-level tests using npx vitest run before submitting PRs
  • Run npm run build to verify the build passes
  • Notes that these correspond to the ui_tests and ui_build CI checks

The existing "Submitting a PR" section is renumbered from 4 to 5. All claims in the documentation are consistent with the actual project configuration (vitest is set up, tests are co-located with components as .test.tsx files, and npm run build runs next build).

Confidence Score: 5/5

  • This is a documentation-only change with no risk to runtime behavior.
  • Single documentation file changed with accurate, well-structured content. No code changes, no logic modifications, no dependencies affected. The added instructions are verified against the actual project setup.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/my-website/docs/contributing.md Adds a new "Pre-PR Checklist" section (Section 4) with instructions to run vitest and npm run build before submitting UI PRs, and correctly renumbers the subsequent "Submitting a PR" section to 5. Content is accurate and consistent with the existing project setup.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Make UI Changes] --> B[Section 3: UI Development]
    B --> C{Option A or B?}
    C -->|Dev Mode| D[npm run dev - Hot Reload on :3000]
    C -->|Build Mode| E[npm run build + copy to proxy]
    D --> F[Section 4: Pre-PR Checklist]
    E --> F
    F --> G[Run vitest for changed components]
    F --> H[Run npm run build]
    G --> I{Tests pass?}
    H --> J{Build succeeds?}
    I -->|Yes| K[Section 5: Submit PR]
    J -->|Yes| K
    I -->|No| L[Fix test failures]
    J -->|No| M[Fix build errors]
    L --> G
    M --> H
    K --> N[CI runs ui_tests + ui_build]
Loading

Last reviewed commit: 0e0abeb

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant