docs(ui): add pre-PR checklist to UI contributing guide#21886
Open
Chesars wants to merge 1 commit intoBerriAI:mainfrom
Open
docs(ui): add pre-PR checklist to UI contributing guide#21886Chesars wants to merge 1 commit intoBerriAI:mainfrom
Chesars wants to merge 1 commit intoBerriAI:mainfrom
Conversation
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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Greptile SummaryThis PR adds a Pre-PR Checklist section (Section 4) to the UI contributing guide (
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 Confidence Score: 5/5
|
| 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]
Last reviewed commit: 0e0abeb
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Relevant issues
Follow-up to #19353 — incorporates maintainer feedback from @yjiang-litellm on the UI contributing guide.
Pre-Submission checklist
tests/litellm/directory, Adding at least 1 test is a hard requirement - see detailsmake test-unitType
📖 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:npx vitest run src/components/path/to/YourComponent.test.tsxnpm run buildui_testsandui_buildCI checks