caba2f468c
* Create docs (#323) * Create .readthedocs.yaml * Update mkdocs.yml * update * revise * syntax * syntax * syntax * syntax * revise * revise * spacing * Docs (#327) * add stuff * patch homepage * more docs * updated * updated * refresh * refresh * refresh * update * refresh * refresh * refresh * refresh * missing file * refresh * refresh * refresh * refresh * fix black * refresh * refresh * refresh * refresh * add readme for just the docs * Update README.md * add more data loading docs * cleanup data sources * refresh * revised * add search * make prettier * revised * updated * refresh * favi * updated --------- Co-authored-by: Sarah Wooders <sarahwooders@gmail.com>
24 lines
605 B
Markdown
24 lines
605 B
Markdown
# Contributing
|
|
|
|
## Installing from source
|
|
First, install Poetry using [the official instructions here](https://python-poetry.org/docs/#installing-with-the-official-installer).
|
|
|
|
Then, you can install MemGPT from source with:
|
|
```sh
|
|
git clone git@github.com:cpacker/MemGPT.git
|
|
poetry shell
|
|
poetry install
|
|
```
|
|
We recommend installing pre-commit to ensure proper formatting during development:
|
|
```sh
|
|
pip install pre-commit
|
|
pre-commit install
|
|
pre-commit run --all-files
|
|
```
|
|
|
|
### Formatting
|
|
We welcome pull requests! Please run the formatter before submitting a pull request:
|
|
```sh
|
|
poetry run black . -l 140
|
|
```
|