Files

T

zhutoutoutousan 605faf5310 Prepare source-only public release for develop.

Add cluster audit pipeline, united EA updates, brochure generators, and publication hygiene (gitignore, MT5 path desensitization, pre-upload scan). Remove tracked reports, models, and binary artifacts from the repo.

Co-authored-by: Cursor <cursoragent@cursor.com>

2026-07-02 15:03:43 +02:00

1.4 KiB

Raw Permalink Blame History

Contributing

Scope

This repo focuses on MetaTrader 5 Expert Advisors, Python backtesting, and ONNX ML integration. Keep PRs focused on one area (e.g. one strategy or one audit script).

Setup

Clone the repo
Install Python deps per subdirectory (backtesting/MT5/requirements.txt, ai/*/requirements.txt)
Use your local MT5 terminal for tester automation — no account credentials in code

Code conventions

MQL5: match existing Strategies/*.mqh patterns; magic numbers via MagicNumberHelpers.mqh
Python: minimal dependencies; reuse set_parser.py, cluster_audit/united_mt5_runner.py
Sets: name files descriptively; document non-obvious params in strategy README

Do not submit

.env, API keys, account logins
ReportTester*.html, trades.csv, *.ex5
PDF/PNG/JPG charts and brochures (*.pdf, report.png, test-balance.jpg, …)
mt5_results.json, mt5_reports/, lab/**/best_run/
Generated audit JSON under cluster_audit/reports/
Unrelated personal projects or book manuscripts

Before first push, run:

python scripts/prepare_public_upload.py

Pull requests

Describe strategy / audit change and test window used
Note whether results are from MT5 tester or Python replay
Confirm git status shows no ignored sensitive files staged

See docs/STRUCTURE.md for layout.

1.4 KiB Raw Permalink Blame History