document how to run from source (#3)

* document how to run from source and uv lock

* correct install name

* Update CONTRIBUTING.md

* Delete uv.lock

* Update CONTRIBUTING.md

* nit
This commit is contained in:
Michael Neale
2024-08-25 10:51:51 +10:00
committed by GitHub
parent 6375186e3a
commit 8b92fbc829
2 changed files with 17 additions and 6 deletions
+14 -5
View File
@@ -5,24 +5,33 @@ to develop a fix, we recommend you open an issue before starting.
## Prerequisites
*goose* uses [uv][uv] for dependency management, and formats with [ruff][ruff].
We provide a shortcut to standard commands using [just][just] in our `justfile`.
## Developing
* *goose* uses [uv][uv] for dependency management, and formats with [ruff][ruff] - install UV first: https://pypi.org/project/uv/
* clone both this repository as well as https://github.com/square/exchange next to it.
## Developing and testing
Now that you have a local environment, you can make edits and run our tests.
```
```sh
uv run pytest tests -m "not integration"
```
or, as a shortcut,
```
```sh
just test
```
## Running goose from source
`uv run goose session start`
will run a fresh goose session (can use the usual goose commands with `uv run` prefixed)
## Evaluations
Given that so much of *goose* involves interactions with LLMs, our unit tests only go so far to