CONTRIBUTING

So you're looking to contribute to Lemon - that's awesome, we can't wait to see what you do. As a startup with limited headcount and funding, we have grand ambitions to design the most intuitive workflow for building and managing LLM applications. Any help from the community counts, truly.

We need to be nimble and ship fast given where we are, but we also want to make sure that contributors like you get as smooth an experience at contributing as possible. We've assembled this contribution guide for that purpose, aiming at getting you familiarized with the codebase & how we work with contributors, so you could quickly jump to the fun part.

This guide, like Lemon itself, is a constant work in progress. We highly appreciate your understanding if at times it lags behind the actual project, and welcome any feedback for us to improve.

In terms of licensing, please take a minute to read our short License and Contributor Agreement. The community also adheres to the code of conduct.

Bug reports

• A clear and descriptive title
• A detailed description of the bug, including any error messages
• Steps to reproduce the bug
• Expected behavior
• Logs, if available, for backend issues, this is really important, you can find them in docker-compose logs
• Screenshots or videos, if applicable

Feature requests

• A clear and descriptive title
• A detailed description of the feature
• A use case for the feature
• Any other context or screenshots about the feature request

Submitting your PR

Pull Request Process

1. Fork the repository
2. Before you draft a PR, please create an issue to discuss the changes you want to make
3. Create a new branch for your changes
4. Please add tests for your changes accordingly
5. Ensure your code passes the existing tests
6. Please link the issue in the PR description, fixes #<issue_number>
7. Get merged!

Setup the project

Frontend

For setting up the frontend service, please refer to our comprehensive guide in the frontend/README.md file. This document provides detailed instructions to help you set up the frontend environment properly.

Backend

For setting up the backend service, kindly refer to our detailed instructions in the api/README.md file. This document contains step-by-step guidance to help you get the backend up and running smoothly.

Other things to note

We recommend reviewing this document carefully before proceeding with the setup, as it contains essential information about:

• Prerequisites and dependencies
• Installation steps
• Configuration details
• Common troubleshooting tips

Feel free to reach out if you encounter any issues during the setup process.

Getting Help

If you ever get stuck or get a burning question while contributing, simply shoot your queries our way via the related GitHub issue for a quick chat.