mirror of
https://github.com/BerriAI/litellm.git
synced 2026-09-14 23:21:35 +00:00
Add note that docs live in separate litellm-docs repo
Update CONTRIBUTING.md and PR template to inform contributors that documentation lives in BerriAI/litellm-docs and doc PRs should be opened there instead of in this repository. Co-authored-by: Krrish Dholakia <krrish-berri-2@users.noreply.github.com>
This commit is contained in:
parent
d120ddf678
commit
7d2f029acb
2 changed files with 11 additions and 3 deletions
4
.github/pull_request_template.md
vendored
4
.github/pull_request_template.md
vendored
|
|
@ -43,11 +43,13 @@ If you're seeing a delay in your PR being merged, ping the LiteLLM Team on [Slac
|
|||
|
||||
<!-- Select the type of Pull Request -->
|
||||
<!-- Keep only the necessary ones -->
|
||||
<!-- NOTE: Documentation lives in a separate repo: https://github.com/BerriAI/litellm-docs -->
|
||||
<!-- For doc changes, please open a PR there instead. -->
|
||||
|
||||
🆕 New Feature
|
||||
🐛 Bug Fix
|
||||
🧹 Refactoring
|
||||
📖 Documentation
|
||||
📖 Documentation (submit doc PRs to [litellm-docs](https://github.com/BerriAI/litellm-docs))
|
||||
🚄 Infrastructure
|
||||
✅ Test
|
||||
|
||||
|
|
|
|||
|
|
@ -242,7 +242,7 @@ If `make test-unit` fails:
|
|||
- **Write descriptive commit messages**: Help reviewers understand your changes
|
||||
- **Keep PRs focused**: One feature/fix per PR
|
||||
- **Test edge cases**: Don't just test the happy path
|
||||
- **Update documentation**: If you change APIs, update docs
|
||||
- **Update documentation**: If you change APIs, update docs in the [litellm-docs](https://github.com/BerriAI/litellm-docs) repo (see [Documentation](#documentation) below)
|
||||
|
||||
## Building and Running Locally
|
||||
|
||||
|
|
@ -312,6 +312,12 @@ Ensure the UI builds successfully before submitting your PR:
|
|||
npm run build
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
LiteLLM documentation lives in a **separate repository**: [BerriAI/litellm-docs](https://github.com/BerriAI/litellm-docs), served at [docs.litellm.ai](https://docs.litellm.ai).
|
||||
|
||||
**Do not create or edit documentation files in this repository.** If your changes require documentation updates, please open a separate PR against the [litellm-docs](https://github.com/BerriAI/litellm-docs) repo.
|
||||
|
||||
## Submitting Your PR
|
||||
|
||||
1. **Push your branch**: `git push origin your-feature-branch`
|
||||
|
|
@ -336,7 +342,7 @@ Looking for ideas? Check out:
|
|||
|
||||
- 🐛 [Good first issues](https://github.com/BerriAI/litellm/labels/good%20first%20issue)
|
||||
- 🚀 [Feature requests](https://github.com/BerriAI/litellm/labels/enhancement)
|
||||
- 📚 Documentation improvements
|
||||
- 📚 Documentation improvements (in the [litellm-docs](https://github.com/BerriAI/litellm-docs) repo)
|
||||
- 🧪 Test coverage improvements
|
||||
- 🔌 New LLM provider integrations
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue