Add issue templates (#41)
* Add bug report template * Add feature request template * Typo fix Co-authored-by: TimJentzsch <tim-jentzsch@gmx.de> * fix Markdown lint error of bug report template * fix lint error of feature request template Co-authored-by: TimJentzsch <tim-jentzsch@gmx.de>
Semantic delta
No definition changed: this change is text, documentation or data.
2 files · +63 −0
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..6a4b5f6b5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,39 @@
+---
+name: Bug Report
+about: Report a bug to help us improve!
+title: ''
+labels: bug
+assignees: ''
+---
+
+## stretch2 version
+
+The release number or commit hash of the version you're using.
+
+## Platform
+
+What platform are you using stretch2 on? e.g. Rust, Andriod, IOS, JavaScript/TypeScript
+
+## What you did
+
+The steps you took to uncover this bug.
+
+Please provide a runnable code snippet or link to an example that demonstrates the problem if you can.
+
+## What went wrong
+
+If it's not clear:
+
+- what were you expecting?
+- what actually happened?
+
+## Additional information
+
+Other information that can be used to further reproduce or isolate the problem.
+This commonly includes:
+
+- screenshots
+- logs
+- theories about what might be going wrong
+- workarounds that you used
+- links to related bugs, PRs or discussions
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..238a7ad57
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,24 @@
+---
+name: Feature Request
+about: Propose a new feature!
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+## What problem does this solve or what need does it fill?
+
+A description of why this particular feature should be added.
+
+## What solution would you like?
+
+The solution you propose for the problem presented.
+
+## What alternative(s) have you considered?
+
+Other solutions to solve and/or work around the problem presented.
+
+## Additional context
+
+Any other information you would like to add such as related previous work,
+screenshots, benchmarks, etc.