Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (35 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 1.75 KB

Contributing to Experanto

Code of Conduct

This project follows the Contributor Covenant v3.0. By participating, you are expected to uphold it.

Setup

git clone https://github.com/sensorium-competition/experanto.git
cd experanto
pip install -e ".[dev]"

Code Style

We use black, isort, and pyright — all configured in pyproject.toml. Docstrings should follow NumPy style.

Tests

Tests live in tests/. Synthetic data fixtures are created via context managers in tests/create_*.py — follow this pattern for new tests so no real data files are left on disk.

pytest                                       # all tests
pytest tests/test_sequence_interpolator.py  # single file

Documentation

All sources are in the docs/ folder. To build locally:

  1. Install the documentation dependencies:

    pip install -e ".[docs]"

  2. From inside the docs/ folder:

    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.
  • Keep documentation up to date — add, update, or remove docstrings and docs/source/ pages to reflect your changes.