Resolve merge conflicts

Author: BitForge95

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+## Description
+
+<!-- What does this PR do and why? Link the issue it addresses. -->
+
+Closes #
+
+---
+
+Please read [CONTRIBUTING.md](https://github.com/sensorium-competition/experanto/blob/main/CONTRIBUTING.md) thoroughly before submitting — especially the Pull Requests section.

.github/workflows/docs.yml

@@ -28,13 +28,12 @@ jobs:
         with:
           python-version: '3.12.8'
 
-      - name: Install dependencies
+      - name: Install documentation dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -e . --no-deps
-          pip install -r docs/source/requirements.txt
+          pip install -e ".[docs]"
 
       - name: Build docs
         run: |
           cd docs
-          make html SPHINXOPTS="-W --keep-going"
+          make html SPHINXOPTS="-W --keep-going"

.github/workflows/ruff.yml

@@ -0,0 +1,29 @@
+name: CI - Ruff Linting
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  ruff:
+    name: Ruff Linting
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'push' ||
+      (
+        github.event_name == 'pull_request' &&
+        github.repository != github.event.pull_request.head.repo.full_name
+      )
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Run Ruff
+        uses: astral-sh/ruff-action@v3
+        with:
+          version: "0.15.6"
+          args: "check"

.gitignore

@@ -129,6 +129,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+*env/
 
 # Spyder project settings
 .spyderproject
@@ -164,4 +165,4 @@ cython_debug/
 *.sif
 *.bak
 
-docs/source/generated/
+docs/source/generated/

.readthedocs.yml

@@ -8,7 +8,10 @@ build:
 
 python:
   install:
-    - requirements: docs/source/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
 
 sphinx:
   configuration: docs/source/conf.py

CONTRIBUTING.md

@@ -29,18 +29,23 @@ pytest tests/test_sequence_interpolator.py  # single file
 
 All sources are in the `docs/` folder. To build locally:
 
-1. Install Sphinx and the ReadTheDocs theme:
+1. Install the documentation dependencies:
    ```bash
-   pip install sphinx sphinx-rtd-theme
+   pip install -e ".[docs]"
    ```
+
 2. From inside the `docs/` folder:
    ```bash
+   cd docs
    make clean html
    ```
+
 3. Open `docs/build/html/index.html` in your browser.
 
 ## Pull Requests
 
+Before submitting a PR, please open an issue to discuss your proposed change. PRs that merely reorganize or copy existing code without clear motivation, or that don't align with the project's direction, will be closed without review. Maintainer time is limited — please use it respectfully.
+
 - Keep PRs focused; one logical change per PR.
 - All existing tests must pass; add tests for new behavior.
 - Code style checks and type checking must pass.

README.md

@@ -2,6 +2,9 @@
 
 Experanto is a Python package designed for interpolating recordings and stimuli in neuroscience experiments. It enables users to load single or multiple experiments and create efficient dataloaders for machine learning applications.
 
+> [!IMPORTANT]
+> If you're interested in contributing or looking for a **Google Summer of Code** project, we discuss ideas and planned features in this [ideas thread](https://github.com/sensorium-competition/experanto/discussions/101) — please share your thoughts there before opening a PR.
+
 ## Features
 
 - **Unified Experiment Interface**: Load and query multi-modal neuroscience data (neural responses, eye tracking, treadmill, visual stimuli) through a single `Experiment` class

docs/source/conf.py

@@ -28,6 +28,7 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
+    "myst_parser",
 ]
 
 # -- Autosummary settings ----------------------------------------------------
@@ -77,7 +78,6 @@
     "cv2",
     "pandas",
     "hydra",
-    "omegaconf",
     "jaxtyping",
     "plotly",
     "optree",

docs/source/contributing.md

@@ -0,0 +1,2 @@
+```{include} ../../CONTRIBUTING.md
+```

docs/source/index.rst

@@ -24,6 +24,12 @@ Issues with the package can be submitted at our `GitHub Issues page <https://git
    concepts/demo_dataset
    concepts/demo_multisession
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Development
+
+   contributing
+
 .. toctree::
    :maxdepth: 2
    :caption: API Reference