diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..0a02e2b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,62 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +### Describe the bug + + + +Given , which has ... + +When I do... + +Then I wanted to see... + +But instead I got... + +### Investigation + +I have investigated and I think the problem is.... + +I have searched both [Dokkatoo](https://github.com/search?q=repo%3Aadamko-dev%2Fdokkatoo) and [Dokka](https://github.com/search?q=repo%3AKotlin%2FDokka&type=code) and found these related... + +I am sure that this is a problem with [Dokkatoo](https://github.com/adamko-dev/dokkatoo/) and *not* [Dokka](https://github.com/Kotlin/dokka) because... + +### To Reproduce + +You can reproduce the behaviour by... + +### To Workaround + +I can workaround the problem by... + +### Additional Context + + + +#### Versions + +* Dokkatoo version: +* (if set) Dokka version: +* Gradle version: +* Kotlin version: +* Kotlin target(s): JVM/JS/Native/Wasm + +#### `build.gradle.(kts)` + +```kotlin +// build.gradle.kts +``` + + + + + +### Additional information + + diff --git a/.github/ISSUE_TEMPLATE/documentation-issue.md b/.github/ISSUE_TEMPLATE/documentation-issue.md new file mode 100644 index 00000000..8ae1e2d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-issue.md @@ -0,0 +1,10 @@ +--- +name: Documentation issue +about: Unclear, confusing, or incomplete documentation +title: '' +labels: documentation +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..11fc491e --- /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. diff --git a/.github/ISSUE_TEMPLATE/help-or-question.md b/.github/ISSUE_TEMPLATE/help-or-question.md new file mode 100644 index 00000000..58b9e492 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help-or-question.md @@ -0,0 +1,10 @@ +--- +name: Help or Question +about: I have a question, or I would like help configuring Dokkatoo +title: '' +labels: question +assignees: '' + +--- + +