Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (32 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 1.38 KB
Raw

Contributing to ECHO

Thank you for helping improve ECHO. Contributions that improve reproducibility, portability, documentation, tests, or scientifically justified model variants are welcome.

Development setup

git clone https://github.com/OucAI4ScienceLab/Echo.git
cd Echo
python -m venv .venv
python -m pip install --upgrade pip
pip install -e ".[dev]"
python -m unittest discover -s tests -v
ruff check src scripts tests

The optional fused Mamba implementation is not required for the test suite. Tests use the portable selective-SSM fallback.

Pull requests

  1. Create a focused branch from main.
  2. Keep changes scoped and add tests for behavioral changes.
  3. Run the test and lint commands above.
  4. Explain the scientific or engineering rationale in the pull request.
  5. Do not commit private recordings, labels, credentials, or generated model artifacts.

Changes that claim improved scientific performance should identify the data split, evaluation metric, random seeds, and comparison protocol. Results from synthetic smoke-test data are not scientific evidence.

Issues

Use GitHub issues for reproducible bugs and feature proposals. Include the operating system, Python and PyTorch versions, selected Mamba backend, command, configuration, and full error message where relevant.

By participating, you agree to follow the project Code of Conduct.