summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorChristoph Schlosser <2466365+cschlosser@users.noreply.github.com>2021-05-31 19:08:39 +0200
committerGitHub <noreply@github.com>2021-05-31 19:08:39 +0200
commitbf8ef61d37200f952e372ec7110bdc0a5a5861f9 (patch)
tree0991bcf75d8e16fc0d4469fd1bcf0afac75907b8 /.github
parentae6f6bea6339f578d7d6e7850683f17a8bf0e175 (diff)
downloaddoxdocgen-bf8ef61d37200f952e372ec7110bdc0a5a5861f9.tar.gz
Update issue templates
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md44
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md20
2 files changed, 64 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.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..11fc491
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.