Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (25 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

32 lines (25 loc) · 1.07 KB
Raw

Contributing

This is a completed competition project (Jump Trading Probability Cup 2026), open-sourced as a reference and portfolio piece. It is not under active development, but issues and small PRs are welcome.

Issues welcome for

  • Corrections to the strategy/maths docs or the retrospective
  • Questions about the forecasting approach, the models, or the bot
  • Ideas for a future Probability Cup

PRs welcome for

  • Bug fixes in the bot / scripts
  • Typo and clarity fixes in the docs
  • Additional visualisations generated from results/ data

Please don't

  • Re-litigate individual competition predictions — the tournament is over and results are final.
  • Add raw third-party odds/data files — those are gitignored for licensing reasons (see docs/COMPETITION_TERMS.md).

Dev setup

python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pre-commit install          # runs gitleaks + hygiene hooks on commit
PYTHONPATH=. pytest -q      # run the bot tests

All contributions are accepted under the repository's MIT licence.