Devid HW
d8b0b37919
The scripts/cii_criteria.py helper fetches bestpractices.dev criteria and generates pre-filled edit URLs for each criterion, streamlining badge maintenance. CONTRIBUTING.md backs the contribution and testing criteria referenced by the CII best-practices submission.
1.5 KiB
1.5 KiB
Contributing to MT5-Quant
Thanks for your interest in improving MT5-Quant! This document explains how to contribute and what we expect from contributions.
How to contribute
- Fork the repository and create a topic branch from
master. - Make your change, keeping it focused (one logical change per PR).
- Open a pull request against
master. A pull request template (.github/PULL_REQUEST_TEMPLATE.md) is provided — please fill it in. - Ensure CI passes (build,
cargo test, clippy, formatting, cargo-deny, CodeQL). Maintainers review and merge once checks and review are satisfied.
Development setup
- Install Rust (stable toolchain) and, for full backtests, Wine/MT5 as described
in
README.mdanddocs/QUICKSTART.md. - Build the release binary with either:
bash scripts/build-rust.sh, orcargo build --release
- The binary is produced at
target/release/mt5-quant.
Testing requirement
- Non-trivial changes must include tests. New functionality should come with unit or integration tests where practical.
cargo testruns automatically in CI (rust.yml) on every push and pull request, so a change that breaks tests cannot merge.
Commit style
- Follow Conventional Commits (
feat:,fix:,docs:,refactor:,test:,release:), as documented inAGENTS.md.
Issue tracker
- Bugs and enhancement requests are tracked on the project's
GitHub Issues, with
bug-report and feature-request templates under
.github/ISSUE_TEMPLATE/.