Create CONTRIBUTING.md

This commit is contained in:
Charles Packer
2025-12-14 15:24:15 -08:00
committed by GitHub
parent 7e30b29c37
commit c704e65fd0

39
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,39 @@
# Contributing to Letta Code
## Fork the repo
Fork the repository on GitHub by [clicking this link](https://github.com/letta-ai/letta-code/fork), then clone your fork:
```bash
git clone https://github.com/your-username/letta-code.git
cd letta-code
```
## Installing from source
Requirements:
* [Bun](https://bun.com/docs/installation)
### Run directly from source (dev workflow)
```bash
# install deps
bun install
# run the CLI from TypeScript sources (pick up changes immediately)
bun run dev
bun run dev -- -p "Hello world" # example with args
```
### Build + link the standalone binary
```bash
# build bin/letta (includes prompts + schemas)
bun run build
# expose the binary globally (adjust to your preference)
bun link
# now you can run the compiled CLI
letta
```
Whenever you change source files, rerun `bun run build` before using the linked `letta` binary so it picks up your edits.