Skip to content

Commit

Permalink
Improve issue templates with new format
Browse files Browse the repository at this point in the history
  • Loading branch information
joffrey-bion committed Aug 15, 2023
1 parent fbca5ce commit 7924cbb
Show file tree
Hide file tree
Showing 9 changed files with 148 additions and 60 deletions.
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: Bug report
description: File a bug report
labels: ["bug"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
placeholder: Incorrect behaviour, error message, stacktrace...
description: Please describe what you see and what you expected to happen instead.
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction and additional details
placeholder: Snippet of code, contextual information...
description: Please provide information that could help reproduce the problem.
validations:
required: false
- type: input
id: krossbow-version
attributes:
label: Krossbow version
validations:
required: true
- type: dropdown
id: krossbow-modules
attributes:
label: Krossbow modules
description: |
Select the Krossbow modules that you're using in your project. You don't have to specify all transitive
dependencies (the ones that you're declaring in your project are enough), but it's ok if you do.
If a module you're using is not in the list, please check `Other` and specify it in the "additional details"
section.
multiple: true
options:
- krossbow-stomp-core
- krossbow-stomp-jackson
- krossbow-stomp-kxserialization
- krossbow-stomp-kxserialization-json
- krossbow-stomp-moshi
- krossbow-websocket-builtin
- krossbow-websocket-core
- krossbow-websocket-ktor
- krossbow-websocket-okhttp
- krossbow-websocket-sockjs
- krossbow-websocket-spring
- Other (please specify in "additional details")
validations:
required: true
- type: input
id: kotlin-version
attributes:
label: Kotlin version
validations:
required: true
- type: dropdown
id: kotlin-platforms
attributes:
label: Kotlin target platforms
description: |
Select the Kotlin target platform(s) where you noticed the bug. If a target you're using is not in the list,
please check `Other` and specify it in the "additional details" section.
multiple: true
options:
- All targets / irrelevant
- Android
- JVM (non-Android)
- JS (browser)
- JS (node)
- Native - iOS
- Native - watchOS
- Native - tvOS
- Native - macOS
- Native - Linux
- Native - Windows (minGW)
- Native - Android NDK
- Other (please specify in "additional details")
validations:
required: true
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature request or enhancement
description: Suggest an idea for this project, be it a big feature or a small UX improvement
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to suggest ideas!
- type: textarea
id: problem
attributes:
label: Problem / use case
description: |
Why is this useful? What problem or inconvenience does it solve?
Don't hesitate to provide some context about what you're trying to achieve on a larger scale, this helps
designing the feature with a real use-case in mind, possibly in a different way than what's suggested here.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Feature (solution)
description: What are you suggesting? What would it look like?
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Current alternatives
description: Is there a way -maybe inconvenient- to achieve your goal at the moment, or a workaround?
validations:
required: false
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/3-documentation_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Documentation
description: Report a problem with the documentation
labels: [ "documentation" ]
body:
- type: markdown
attributes:
value: Thanks for taking the time to open an issue!
- type: textarea
id: description
attributes:
label: Problem description
description: |
Please describe the problem as concisely as possible.
If it's a clear typo, don't hesitate to open a PR to fix it instead of opening an issue.
validations:
required: true
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/4-dependency_upgrade.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Dependency upgrade
description: Upgrade a dependency
title: Upgrade ARTIFACT_NAME to version VERSION
labels: ["dependencies"]
body:
- type: textarea
id: additional-info
attributes:
label: Additional information
description: If this version upgrade is necessary for a specific reason, please describe why.
validations:
required: false
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question
about: For general usage questions, please use GitHub Discussions
url: https://github.com/joffrey-bion/krossbow/discussions
8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE/dependency.md

This file was deleted.

18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE/other.md

This file was deleted.

0 comments on commit 7924cbb

Please sign in to comment.