From be9b07c5dd53f9cc56c93049f449126b62e78dea Mon Sep 17 00:00:00 2001 From: danielmjrr <218780195+danielmjrr@users.noreply.github.com> Date: Thu, 22 Oct 2026 19:26:22 +0200 Subject: [PATCH] Add issue templates for bugs and suggestions --- .github/ISSUE_TEMPLATE/bug.yml | 36 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/suggestion.yml | 16 ++++++++++++ 3 files changed, 53 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/suggestion.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..d24c2a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,36 @@ +name: Bug report +description: Something in tickreplay does not work as it must. +labels: [bug] +body: + - type: textarea + id: what + attributes: + label: What happened + description: Tell us what you saw. Paste the full error and traceback if there is one. + validations: + required: true + - type: textarea + id: expected + attributes: + label: What you expected + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: A short script is best. Use synthetic ticks from tickreplay.synth if you cannot share your data. + render: python + validations: + required: true + - type: input + id: version + attributes: + label: tickreplay version + description: Run `python -c "import tickreplay; print(tickreplay.__version__)"`. + placeholder: 0.1.0 + - type: input + id: env + attributes: + label: Python, numba and OS + placeholder: Python 3.13, numba 0.61, macOS 15 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/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml new file mode 100644 index 0000000..fa11820 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -0,0 +1,16 @@ +name: Suggestion +description: Ask for a new feature or a change. +labels: [suggestion] +body: + - type: textarea + id: problem + attributes: + label: What do you want to do + description: Tell us the backtest or research task that tickreplay makes hard or does not support. + validations: + required: true + - type: textarea + id: idea + attributes: + label: Your idea + description: How can tickreplay help with this task?