Lemonade SDK Contribution Guide

The Lemonade SDK project welcomes contributions from everyone!

See code organization for an overview of the repository.

Collaborate with Your App

Lemonade Server integrates quickly with most OpenAI-compatible LLM apps.

You can: - Share an example of your app using Lemonade via Discord, GitHub Issue, or email. - Contribute a guide by adding a .md file to the server apps folder. Follow the style of the Open WebUI guide.

Guides should: - Work in under 10 minutes. - Require no code changes to the app. - Use OpenAI API-compatible apps with configurable base URLs.

SDK Contributions

To contribute code or examples, first open an Issue with: - A descriptive title. - Relevant labels (enhancement, good first issue, etc.). - A proposal explaining what you're contributing. - The use case it supports.

One of the maintainers will get back to you ASAP with guidance.

Issues

Use Issues to report bugs or suggest features.

A maintainer will apply one of these labels to indicate the status: - on roadmap: planned for development. - good first issue: open for contributors. - needs detail: needs clarification before proceeding. - wontfix: out of scope or unmaintainable.

Pull Requests

Submit a PR to contribute code. Maintainers: - @danielholanda - @jeremyfowers - @ramkrishna - @vgodsoe

Discuss major changes via an Issue first.

Testing

Tests are run automatically on each PR. These include: - Linting - Code formatting (black) - Unit tests - End-to-end tests

To run tests locally, use the commands in .github/workflows/.

Versioning

We follow Semantic Versioning.