Chore: pre-commit, pre-commit action, contribution guide update

.env.example

@@ -3,3 +3,7 @@
 # CORS_ALLOWED_ORIGINS="https://yourdomain.com,https://another.com"
 # For local development, you might use:
 # CORS_ALLOWED_ORIGINS="http://localhost:3000"
+
+LLM_API_KEY="your-openai-api-key"
+LLM_MODEL="openai/gpt-4o-mini"
+LLM_PROVIDER="openai"

.github/pull_request_template.md

@@ -29,7 +29,7 @@ DO NOT use AI-generated descriptions. We want to understand your thought process
 
 ## Pre-submission Checklist
 <!-- Please check all boxes that apply before submitting your PR -->
-- [ ] **I have tested my changes thoroughly before submitting this PR**
+- [ ] **I have tested my changes thoroughly before submitting this PR** (See `CONTRIBUTING.md`)
 - [ ] **This PR contains minimal changes necessary to address the issue/feature**
 - [ ] My code follows the project's coding standards and style guidelines
 - [ ] I have added tests that prove my fix is effective or that my feature works

.github/workflows/pre_test.yml

@@ -13,10 +13,15 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Install uv
+      - name: Cognee Setup
-        uses: astral-sh/setup-uv@v4
+        uses: ./.github/actions/cognee_setup
         with:
-          enable-cache: true
+          python-version: '3.11.x'
 
       - name: Validate uv lockfile and project metadata
         run: uv lock --check || { echo "'uv lock --check' failed."; echo "Run 'uv lock' and push your changes."; exit 1; }
+
+      - name: Run pre-commit hooks
+        run: |
+          uv run pip install pre-commit
+          pre-commit run

.gitignore

@@ -147,6 +147,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+mise.toml
 
 # Spyder project settings
 .spyderproject

CONTRIBUTING.md

@@ -62,6 +62,11 @@ Looking for a place to start? Try filtering for [good first issues](https://gith
 
 ## 2. 🛠️ Development Setup
 
+### Required tools
+* [Python](https://www.python.org/downloads/)
+* [uv](https://docs.astral.sh/uv/getting-started/installation/)
+* pre-commit: `uv run pip install pre-commit && pre-commit install`
+
 ### Fork and Clone
 
 1. Fork the [**cognee**](https://github.com/topoteretes/cognee) repository
@@ -93,29 +98,31 @@ git checkout -b feature/your-feature-name
 4. **Commits**: Write clear commit messages
 
 ### Running Tests
+
+Rename `.env.example` into `.env` and provide your OPENAI_API_KEY as LLM_API_KEY
+
 ```shell
-python cognee/cognee/tests/test_library.py
+uv run python cognee/tests/test_library.py
 ```
 
 ### Running Simple Example
 
-Change .env.example into .env and provide your OPENAI_API_KEY as LLM_API_KEY
+Rename `.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
+python examples/python/simple_example.py
 ```
 or
 
 ```shell
-uv run python cognee/cognee/examples/python/simple_example.py
+uv run python examples/python/simple_example.py
 ```
 
 ## 4. 📤 Submitting Changes
 
-1. Install ruff on your system
+1. Make sure that `pre-commit` and hooks are installed. See `Required tools` section for more information. Try executing `pre-commit run` if you are not sure.
-2. Run ```ruff format .``` and ``` ruff check ``` and fix the issues
 3. Push your changes:
 ```shell
 git add .