mirror of
https://github.com/tiennm99/litellm.git
synced 2026-06-17 18:48:36 +00:00
Mateo Wang
f27df8d516
* docs: replace generated CLAUDE.md with hand-written guidance, remove AGENTS.md Swap the auto-generated CLAUDE.md for a concise hand-written version that captures how we actually want agents to work in this repo: minimal comments, simplicity first, meaningful tests with a high mutation kill rate, PRs based off litellm_internal_staging rather than main, and curl against a live proxy as proof of fix instead of pasted pytest output. Remove AGENTS.md so there is one source of truth for agent guidance. The customer and company name confidentiality policy, along with the MCP available_on_public_internet note, are carried over from the previous CLAUDE.md. * fix: further clarify communication guidelines * docs: point GEMINI.md at CLAUDE.md instead of duplicating guidance Replace the standalone GEMINI.md copy, which had already drifted from the new CLAUDE.md, with a one-line pointer so Gemini reads the same single source of truth. * docs: simplify PR template test checklist item Replace the rigid "at least 1 test is a hard requirement" checklist line with "I have added meaningful tests", which matches the testing guidance in CLAUDE.md, and tidy a comma into a semicolon in the scope-isolation item. * docs: point AGENTS.md at CLAUDE.md instead of deleting it Keep AGENTS.md so tools that read it still resolve guidance, but collapse it to the same one-line pointer to CLAUDE.md used by GEMINI.md, keeping a single source of truth. * fix: make AI-generated rules more concise * fix: spelling Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * fix: make the .env usage more careful * docs: restore MCP available_on_public_internet note to CLAUDE.md The PR description states this note was carried over verbatim from the previous CLAUDE.md, but it was dropped in the rewrite. Restore it so the file matches the description and the team guidance is not lost. * docs: restore browser storage and CI supply-chain safety notes to CLAUDE.md These security-relevant rules were dropped in the rewrite. Restore the sessionStorage-over-localStorage (XSS) guidance and the CI supply-chain rules (no curl|bash, pin versions, verify checksums) so agents editing UI or CI code are still steered away from those pitfalls. * docs: move area-specific guidance into nested CLAUDE.md files The MCP, browser-storage, and CI supply-chain notes are scoped to particular parts of the tree, so move each into a nested CLAUDE.md that Claude Code loads on demand when those files are touched: the MCP note under the mcp_server gateway, the browser-storage rule under the UI dashboard, and the CI supply-chain rules under .circleci. Keeps the root CLAUDE.md focused on general guidance while the area notes surface where they are relevant. * docs: keep CI supply-chain note in root CLAUDE.md CI guidance applies beyond .circleci (it also covers downloads in GitHub workflows and any CI script), and CI work does not reliably touch a single subtree, so a nested file under .circleci would not surface it dependably. Keep it in the always-loaded root instead. The MCP and browser-storage notes stay nested where they map cleanly to one area of the tree. * fix: make it clear we prefer httpOnly * chore: make ci rule more concise * chore: make concise Fix formatting and punctuation in MCP note. * fix: don't include Claude attribution --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
59 lines
1.8 KiB
Markdown
59 lines
1.8 KiB
Markdown
## Relevant issues
|
|
|
|
<!-- e.g. "Fixes #000" -->
|
|
|
|
## Linear ticket
|
|
|
|
<!-- if you are an internal contributor, add the Linear ticket e.g. "Resolves LIT-1234" to magically link the Linear ticket to the GitHub PR -->
|
|
|
|
## Pre-Submission checklist
|
|
|
|
**Please complete all items before asking a LiteLLM maintainer to review your PR**
|
|
|
|
- [ ] I have added meaningful tests
|
|
- [ ] My PR passes all unit tests on [`make test-unit`](https://docs.litellm.ai/docs/extras/contributing_code)
|
|
- [ ] My PR's scope is as isolated as possible; it only solves 1 specific problem
|
|
- [ ] I have requested a Greptile review by commenting `@greptileai` and received a **Confidence Score of at least 4/5** before requesting a maintainer review
|
|
|
|
## Delays in PR merge?
|
|
|
|
If you're seeing a delay in your PR being merged, ping the LiteLLM Team on [Slack (#pr-review)](https://join.slack.com/t/litellmossslack/shared_invite/zt-3o7nkuyfr-p_kbNJj8taRfXGgQI1~YyA).
|
|
|
|
## CI (LiteLLM team)
|
|
|
|
> **CI status guideline:**
|
|
>
|
|
> - 50-55 passing tests: main is stable with minor issues.
|
|
> - 45-49 passing tests: acceptable but needs attention
|
|
> - <= 40 passing tests: unstable; be careful with your merges and assess the risk.
|
|
|
|
- [ ] **Branch creation CI run**
|
|
Link:
|
|
|
|
- [ ] **CI run for the last commit**
|
|
Link:
|
|
|
|
- [ ] **Merge / cherry-pick CI run**
|
|
Links:
|
|
|
|
## Screenshots / Proof of Fix
|
|
|
|
<!-- Include screenshots, screen recordings, or log output demonstrating that your changes work as expected.
|
|
For bug fixes: show reproduction before the fix and passing behavior after.
|
|
For new features: show the feature working end-to-end.
|
|
For UI changes: include before/after screenshots. -->
|
|
|
|
## Type
|
|
|
|
<!-- Select the type of Pull Request -->
|
|
<!-- Keep only the necessary ones -->
|
|
|
|
🆕 New Feature
|
|
🐛 Bug Fix
|
|
🧹 Refactoring
|
|
📖 Documentation
|
|
🚄 Infrastructure
|
|
✅ Test
|
|
|
|
## Changes
|