Skip to content

Latest commit

 

History

History
177 lines (123 loc) · 5.88 KB

CONTRIBUTING.md

File metadata and controls

177 lines (123 loc) · 5.88 KB

🚀 How to Contribute to Letta

Thank you for investing time in contributing to our project! Here's a guide to get you started.

1. 🚀 Getting Started

🍴 Fork the Repository

First things first, let's get you a personal copy of Letta to play with. Think of it as your very own playground. 🎪

  1. Head over to the Letta repository on GitHub.
  2. In the upper-right corner, hit the 'Fork' button.

🚀 Clone the Repository

Now, let's bring your new playground to your local machine.

git clone https://github.com/your-username/letta.git

🧩 Install dependencies & configure environment

This project requires PostgreSQL to be installed and running on your system. Assuming you have a running PostgreSQL instance, first you need to create the user, database and ensure the pgvector extension is ready. Here are sample steps for a case where user and database name is letta and assumes no password is set:

1. Enter the PostgreSQL Shell

Open your terminal (or Command Prompt on Windows) and run:

# On Mac/Linux:
sudo -u postgres psql

# On Windows:
psql -U postgres

2. Run Setup Commands

Once inside the PostgreSQL prompt (you will see postgres=#), run the following SQL block:

-- 1. Create a dedicated role with login and superuser permissions
CREATE ROLE letta WITH LOGIN SUPERUSER PASSWORD 'letta';

-- 2. Create the database and assign 'letta' as the owner
CREATE DATABASE letta OWNER letta;

-- 3. Switch connection to the new 'letta' database
\c letta

-- 4. Enable the pgvector extension for vector embeddings
CREATE EXTENSION IF NOT EXISTS vector;

Setup the environment variable to tell letta code to contact PostgreSQL database:
```shell
export LETTA_PG_URI="postgresql://${POSTGRES_USER:-letta}:${POSTGRES_PASSWORD:-letta}@localhost:5432/${POSTGRES_DB:-letta}"

Install uv and dependencies

First, install uv using the official instructions here.

Once uv is installed, navigate to the letta directory and install the Letta project with uv:

cd letta
eval $(uv env activate)
uv sync --all-extras
After this you need to prep the database with initial content. You can use alembic upgrade to populate the initial
contents from template test data.
```shell
uv run alembic upgrade head

Running letta with uv

Now when you want to use letta, you can use uv run to run any letta command:

uv run letta server

Installing pre-commit

We recommend installing pre-commit to ensure proper formatting during development:

uv run pre-commit install
uv run pre-commit run --all-files

If you don't install pre-commit, you will need to run uv run black . before submitting a PR.

2. 🛠️ Making Changes

🌟 Create a Branch

Time to put on your creative hat and make some magic happen. First, let's create a new branch for your awesome changes. 🧙‍♂️

git checkout -b feature/your-feature

✏️ Make your Changes

Now, the world is your oyster! Go ahead and craft your fabulous changes. 🎨

Handling Database Migrations

If you are running Letta for the first time, your database will be automatically be setup. If you are updating Letta, you may need to run migrations. To run migrations, use the following command:

uv run alembic upgrade head

Creating a new Database Migration

If you have made changes to the database models, you will need to create a new migration. To create a new migration, use the following command:

uv run alembic revision --autogenerate -m "Your migration message here"

Visit the Alembic documentation for more information on creating and running migrations.

3. ✅ Testing

Before we hit the 'Wow, I'm Done' button, let's make sure everything works as expected. Run tests and make sure the existing ones don't throw a fit. And if needed, create new tests. 🕵️

Run existing tests

Running tests:

uv run pytest -s tests

Running tests if you installed via pip:

pytest -s tests

Creating new tests

If you added a major feature change, please add new tests in the tests/ directory.

4. 🧩 Adding new dependencies

If you need to add a new dependency to Letta, please add the package via uv add <PACKAGE_NAME>. This will update the pyproject.toml and uv.lock files. If the dependency does not need to be installed by all users, make sure to mark the dependency as optional in the pyproject.toml file and if needed, create a new extra under [project.optional-dependencies].

5. 🚀 Submitting Changes

Check Formatting

Please ensure your code is formatted correctly by running:

uv run black . -l 140

🚀 Create a Pull Request

You're almost there! It's time to share your brilliance with the world. 🌍

  1. Visit Letta.
  2. Click "New Pull Request" button.
  3. Choose the base branch (main) and the compare branch (your feature branch).
  4. Whip up a catchy title and describe your changes in the description. 🪄

6. 🔍 Review and Approval

The maintainers will take a look and might suggest some cool upgrades or ask for more details. Once they give the thumbs up, your creation becomes part of Letta!

7. 📜 Code of Conduct

Please be sure to follow the project's Code of Conduct.

8. 📫 Contact

Need help or just want to say hi? We're here for you. Reach out through filing an issue on this GitHub repository or message us on our Discord server.

Thanks for making Letta even more fantastic!

WIP - 🐋 Docker Development

If you prefer to keep your resources isolated by developing purely in containers, you can start Letta in development with:

docker compose -f compose.yaml -f development.compose.yml up

This will volume mount your local codebase and reload the server on file changes.