Add issue templates for bugs and suggestions

2026-10-22 19:26:22 +02:00
parent a7b34d0368
commit be9b07c5dd
3 changed files with 53 additions and 0 deletions
@@ -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
@@ -0,0 +1 @@
+blank_issues_enabled: false
@@ -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?