Commit Graph

17 Commits

Author SHA1 Message Date
Mateo Wang f27df8d516 docs: hand-written CLAUDE.md; point GEMINI.md and AGENTS.md at it (#29252)
* 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>
2026-05-29 00:05:05 -07:00
Mateo Wang 7d69621b59 docs: update pull_request_template to add Linear ticket mentioning
We are replacing daily updates with Linear tickets instead of GitHub PRs directly so linking the two is essential
2026-04-27 17:31:03 -07:00
Krrish Dholakia 01b9b50b43 Add Screenshots / Proof of Fix section to PR template (#25564)
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Krrish Dholakia <krrish-berri-2@users.noreply.github.com>
2026-04-11 10:20:34 -07:00
Krrish Dholakia e0b3fcb34c refactor: update pr template to invite users to slack oss 2026-03-14 15:19:40 -07:00
Krish Dholakia dfa2798169 Fix PR template: correct test directory path from tests/litellm/ to tests/test_litellm/ (#22612)
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2026-03-02 17:49:53 -08:00
shin-bot-litellm d9c69ae9e5 docs: add Greptile review requirement to PR template (#20762) 2026-02-10 22:08:04 -08:00
Cesar Garcia 13c0ab8985 Cleanup PR template: remove redundant fields (#17956)
- Remove Title section (already in PR title)
- Remove screenshot requirement (CI validates tests)

Co-authored-by: Krish Dholakia <krrishdholakia@gmail.com>
2025-12-16 09:39:22 +05:30
AlexsanderHamir 41b67b577b Fix: simplify PR template 2025-12-15 07:44:47 -08:00
Alexsander Hamir debf3598f8 Add: CI/CD rules to default PR template for LiteLLM team. (#17985) 2025-12-15 07:41:17 -08:00
user202729 b482618456 docs: Fix link formatting in GitHub PR template (#10417) 2025-04-29 17:23:53 -07:00
Krrish Dholakia 58f46d847c build: update pull_request_template.md 2025-03-21 16:20:28 -07:00
Cole McIntosh 07813645e0 docs(pr-template): update unit test command in checklist 2025-03-10 20:18:46 -06:00
Ishaan Jaff ce35240273 Pre-Submission checklist 2025-03-10 16:21:53 -07:00
Ishaan Jaff 8198bc2862 Pre-Submission checklist 2025-03-10 15:49:18 -07:00
Marcos Cannabrava c0a7e8352f docs: cleanup docker compose comments (#7414)
* docs: cleanup docker compose comments

* pr template: fix typo
2024-12-25 16:10:31 -08:00
Ishaan Jaff 53ab935151 cleanup PR template 2024-05-13 15:54:58 -07:00
jinno aa6576ad42 docs: add .github/pull_request_template.md 2024-04-29 12:41:29 +09:00