From 344cbd9c902e1e3e25b0b75a105fa142c19b97f5 Mon Sep 17 00:00:00 2001 From: Harrison Chase Date: Fri, 21 Jul 2023 12:01:05 -0700 Subject: [PATCH] update contributor guide (#8088) --- .github/CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ff139139da..e4deedda77 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -69,6 +69,14 @@ This project uses [Poetry](https://python-poetry.org/) as a dependency manager. 3. Tell Poetry to use the virtualenv python environment (`poetry config virtualenvs.prefer-active-python true`) 4. Continue with the following steps. +There are two separate projects in this repository: +- `langchain`: core langchain code, abstractions, and use cases +- `langchain.experimental`: more experimental code + +Each of these has their OWN development environment. +In order to run any of the commands below, please move into their respective directories. +For example, to contribute to `langchain` run `cd libs/langchain` before getting started with the below. + To install requirements: ```bash @@ -248,6 +256,9 @@ When you run `poetry install`, the `langchain` package is installed as editable ## Documentation +While the code is split between `langchain` and `langchain.experimental`, the documentation is one holistic thing. +This covers how to get started contributing to documentation. + ### Contribute Documentation The docs directory contains Documentation and API Reference.