Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue templates #38

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
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. -->

Given <description of my Kotlin Gradle project>, which has <a single/multiple subprojects>...

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

<!-- If applicable, add screenshots to help explain your problem - but no screenshots of code! -->

#### 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
```

<!-- If you have a multi-module Gradle project, please run -->
<!-- ./gradlew projects -q -->
<!-- and include the output in a code block -->

### Additional information

<!-- Add any other information about the problem here. -->
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Documentation issue
about: Unclear, confusing, or incomplete documentation
title: ''
labels: documentation
assignees: ''

---


20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/help-or-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Help or Question
about: I have a question, or I would like help configuring Dokkatoo
title: ''
labels: question
assignees: ''

---