aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug.md38
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md21
-rw-r--r--.github/ISSUE_TEMPLATE/question.md22
3 files changed, 81 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
new file mode 100644
index 00000000..11d748b5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug.md
@@ -0,0 +1,38 @@
+---
+name: Bug
+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
+
+**Expected behaviour**
+A clear and concise description of what you expected to happen
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem
+
+**To Reproduce**
+Steps to reproduce the behavior, ideally with an example project
+
+**Dokka configuration**
+Configuration of dokka used to reproduce the bug
+
+```groovy
+dokka {
+ outputFormat = 'html'
+ ...
+}
+```
+
+**Installation**
+- Operating system: macOS/Windows/Linux
+- Build tool: Gradle v5.6.0/Maven/Cli/3rd party plugin
+- Dokka version: 0.10.0
+
+**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 00000000..3666d865
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,21 @@
+---
+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 [...]
+You can also paste a link to the relevant issue
+
+**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
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 00000000..6a3e22ff
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,22 @@
+---
+name: Question
+about: Ask a question about dokka
+title: ''
+labels: question
+assignees: ''
+
+---
+
+**Question**
+Your question
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem
+
+**Installation**
+- Operating system: macOS/Windows/Linux
+- Build tool: Gradle v5.6.0/Maven/Cli/3rd party plugin
+- Dokka version: 0.10.0
+
+**Additional context**
+Add any other context about the problem here