From 941be795c1ed36e6e7f74857de6bd08d33c1f349 Mon Sep 17 00:00:00 2001 From: Devid HW Date: Tue, 25 Aug 2026 01:52:17 +0700 Subject: [PATCH] chore(templates): add issue forms and PR template --- .github/ISSUE_TEMPLATE/bug_report.yml | 71 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 30 +++++++++ .github/PULL_REQUEST_TEMPLATE.md | 18 ++++++ 4 files changed, 120 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..62d3561 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,71 @@ +name: Bug Report +description: Report a problem with mt5-quant (backtest, compile, analytics, MCP tools) +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug. Please keep answers concise — link gists for very long logs. + + - type: textarea + id: description + attributes: + label: Description + description: A clear, one-paragraph summary of the bug. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Include the MT5 command or MCP tool called, with its arguments (and EA/.set inputs if relevant). + placeholder: | + 1. Call tool `run_backtest` with expert=..., symbol=XAUUSDc, from_date=... + 2. Observe ... + validations: + required: true + + - type: textarea + id: expected_vs_actual + attributes: + label: Expected vs Actual + description: What did you expect to happen, and what actually happened? + validations: + required: true + + - type: dropdown + id: os + attributes: + label: OS + options: + - macOS (Apple Silicon) + - macOS (Intel) + - Linux + validations: + required: true + + - type: dropdown + id: wine_setup + attributes: + label: Wine / CrossOver setup + options: + - CrossOver (macOS) + - MetaTrader 5.app bundled Wine (macOS) + - System Wine on Linux (Xvfb headless) + - Other / not sure + validations: + required: true + + - type: input + id: mt5_build + attributes: + label: MT5 terminal build + description: e.g. 4885 (Help → About in MetaTrader 5) + + - type: textarea + id: logs + attributes: + label: Relevant logs + description: Tester journal, MT5 logs, or MCP server output (wrap in code fences). + render: text diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..a09153d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,30 @@ +name: Feature Request +description: Suggest an idea or improvement for mt5-quant +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a feature. Start with the problem — the solution can be discussed from there. + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: What are you trying to do, and what is missing or painful today? Name the MCP tool(s) involved, if any. + validations: + required: true + + - type: textarea + id: proposed_solution + attributes: + label: Proposed Solution + description: What would you like to happen? Include rough tool names/arguments if it affects the MCP surface. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Other approaches, workarounds you've tried, or existing tools that almost fit. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..bd56630 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +## What & Why + + + +## How Tested + +- [ ] `cargo test` passes +- [ ] `cargo clippy --all-targets -- -D warnings` passes clean +- [ ] `cargo fmt --all -- --check` passes +- [ ] Verified against MT5/Wine locally (only if compile/backtest behavior changed) + +## MCP Tool Impact + +- [ ] No tool schema changes (if schemas changed, list affected tools below) +- [ ] Existing tool outputs unchanged (no breaking changes) +- [ ] Any new tool wired into definitions, handler, and dispatch table + +