From 5b42b21af5da44866d6950141aaf672fffa776ca Mon Sep 17 00:00:00 2001 From: Vasilije <8619304+Vasilije1990@users.noreply.github.com> Date: Mon, 29 Dec 2025 18:00:08 +0100 Subject: [PATCH] Enhance CONTRIBUTING.md with example setup instructions Added instructions for running a simple example and setting up the environment. --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ca815825..87e3dc91c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,6 +97,21 @@ git checkout -b feature/your-feature-name python cognee/cognee/tests/test_library.py ``` +### Running Simple Example + +Change .env.example into .env and provide your OPENAI_API_KEY as LLM_API_KEY + +Make sure to run ```shell uv sync ``` in the root cloned folder or set up a virtual environment to run cognee + +```shell +python cognee/cognee/examples/python/simple_example.py +``` +or + +```shell +uv run python cognee/cognee/examples/python/simple_example.py +``` + ## 4. 📤 Submitting Changes 1. Install ruff on your system