gavindiaz/mt5-ai-xauusd-trader

Fork 0

mirror of https://github.com/triqbit/mt5-ai-xauusd-trader.git synced 2026-11-02 06:56:15 +00:00

Files

T

2a81c11c11 feat: build enterprise contribution governance controls (#974 )

Implemented mandatory governance files to enforce review requirements and contribution standards:
- .github/CODEOWNERS: Defined module ownership for trading/, models/, and core/ with multi-signature requirements.
- .github/PULL_REQUEST_TEMPLATE.md: Mandatory quality gates (tests, 85% coverage, security, docs) and technical checklist.
- .github/ISSUE_TEMPLATE/: Structured templates for bugs, features, and security reports.
- docs/CONTRIBUTING.md: Comprehensive contributor workflow and quality standards.
- docs/ENTERPRISE_STANDARDS.md: Defined engineering standards for linting, typing, and testing.
- tests/test_governance_vitals.py: Updated automated verification for governance vitals.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: andonly1348 <279141437+andonly1348@users.noreply.github.com>

2026-05-10 03:56:19 +00:00

1.4 KiB

Raw Blame History

Enterprise Standards for MT5 AI/ML Trading Bot

This document outlines the engineering standards and quality expectations for all contributions to the repository.

1. Code Quality & Standards

A. Linting & Formatting

We use ruff for linting and formatting. All code must pass ruff check . and ruff format ..

B. Type Safety

We use mypy for static type checking. All source code in src/ must be fully type-hinted.

C. Documentation

Use Google-style docstrings for all public classes and functions.
Maintain up-to-date documentation in the docs/ directory.

2. Testing Standards

Unit Tests: Required for all new logic.
Integration Tests: Required for MT5 and Database interactions.
Coverage: Minimum 85% statement coverage is mandated for all PRs.
TDD: We encourage Test-Driven Development for core trading and risk logic.

3. Git & Workflow

Branching: Use feature/, bugfix/, hotfix/, or docs/ prefixes.
Commits: Follow Conventional Commits (e.g., feat:, fix:, chore:).
PRs: Must complete the PR template and pass all CI gates.

4. Security

Never commit secrets or .env files.
Report vulnerabilities privately according to SECURITY.md.
Use pip-audit to check for dependency vulnerabilities.

5. Performance

Minimize latency in the trading loop.
Use efficient data structures for high-frequency market data handling.

1.4 KiB Raw Blame History