diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yml b/.github/ISSUE_TEMPLATE/1-bug_report.yml new file mode 100644 index 000000000..acd8906cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yml b/.github/ISSUE_TEMPLATE/2-feature_request.yml new file mode 100644 index 000000000..2d70ce050 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/3-documentation_issue.yml b/.github/ISSUE_TEMPLATE/3-documentation_issue.yml new file mode 100644 index 000000000..cde0e37ed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-documentation_issue.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/4-dependency_upgrade.yml b/.github/ISSUE_TEMPLATE/4-dependency_upgrade.yml new file mode 100644 index 000000000..4d80ba64d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-dependency_upgrade.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 2bbf5b972..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** - -(Please describe what you expected and what happened instead.) - -**Reproduction and additional details** - -(Snippet of code, stacktrace, anything else that can help reproduce) - -**Context** - -* Krossbow version: -* Krossbow artifacts used: -* Kotlin version: -* Kotlin target(s): - -If you can, please provide a bit of context about what you were trying to achieve -(it helps to have use cases in mind when fixing the problem or adding new features). diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..fd42c67cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/dependency.md b/.github/ISSUE_TEMPLATE/dependency.md deleted file mode 100644 index 3b2d212c5..000000000 --- a/.github/ISSUE_TEMPLATE/dependency.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -name: Dependency upgrade -about: Upgrade a dependency -title: Upgrade ARTIFACT_NAME to version VERSION -labels: dependencies -assignees: '' - ---- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 6d6f6f910..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**Problem/use case that this feature is meant to solve/enable** - - -**Describe the solution you'd like** - - -**Describe alternatives you've considered** - -(Is there a way -maybe inconvenient- to achieve your goal at the moment, or a workaround?) diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md deleted file mode 100644 index ba98f102d..000000000 --- a/.github/ISSUE_TEMPLATE/other.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -name: Other -about: General questions, documentation issues, etc. -title: '' -labels: '' -assignees: '' - ----