Lacking CONTRIBUTING.MD

[Sachin-Bhat]

Hello everyone,

I believe that the project currently lacks instructions on contributing to the project. Would greatly appreciate if there are instructions on setting up poetry and the test environment. This can also help new contributors write and see if their tests work.

Cheers,
Sachin

[amotl]

Hi @Sachin-Bhat,

while working on GH-157, the outcome and response to your request is attached below.

With kind regards,
Andreas.

Development Sandbox

Acquire sources and create virtualenv.

git clone https://github.com/langchain-ai/langchain-postgres
cd langchain-postgres
uv venv --python=3.13
source .venv/bin/activate

Install package, editable.

poetry install --with dev,test,lint
pip install greenlet

Start PostgreSQL/PGVector.

docker run --rm -it --name pgvector-container \
  -e POSTGRES_USER=langchain \
  -e POSTGRES_PASSWORD=langchain \
  -e POSTGRES_DB=langchain \
  -p 6024:5432 pgvector/pgvector:pg16 \
  postgres -c log_statement=all

Invoke test cases.

pytest -vvv

[amotl]

Hi again. GH-158 includes a relevant patch that adds this information to the repository.

[eyurtsev]

Merged