Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (14 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

23 lines (14 loc) · 1.19 KB
Raw

Contributing to PaperQuant Lab

Thank you for helping improve a safer quantitative-research environment.

Development setup

  1. Install Node.js 22.13+ and Python 3.11+.
  2. Run npm ci in the repository root.
  3. Run python -m pip install -e ".[dev]" inside research-worker.
  4. Start the UI with npm run dev.
  5. Run the complete local gate with npm run check before opening a pull request.

Research contributions

Every strategy change must preserve signal-at-close/next-open execution, completed candles, the 0.5% risk budget, 2× leverage maximum, stop-first same-bar ambiguity, and explicit cost accounting. Add a deterministic fixture test and update the strategy manifest when a dataset requirement changes.

Never turn a missing real dataset into synthetic “historical performance.” Use PARTIAL_DATA or BLOCKED_DATA with an actionable reason.

Security and privacy

Do not add exchange credentials, private endpoints, real-order code, user source code to logs, generated archives, .env files, or R2 artifacts containing secrets. Report vulnerabilities privately as described in SECURITY.md.

By participating, you agree to follow CODE_OF_CONDUCT.md.