summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE/bug_report.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/ISSUE_TEMPLATE/bug_report.md')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..eefc9a8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,44 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Code example**
+
+```Cpp
+// Put your code here
+```
+
+**Expected result**
+
+```Cpp
+/**
+ * @brief Put the expected comment here
+ */
+```
+
+**Actual result**
+
+```Cpp
+/**
+ * @brief Put the actually generated comment here
+ */
+```
+
+**Screencaps**
+If applicable, add screencaps to help explain your problem.
+
+**Your System:**
+ - OS: [Windows, macOS, Linux]
+ - VS Code Version [e.g. 1.55]
+ - Doxdocgen Code Version [e.g. 1.3.1]
+
+**Additional context**
+Add any other context about the problem here.