From 4fca86452bb8c16bbb095904a127084cbc282b3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Filip=20Doln=C3=ADk?= Date: Fri, 20 Oct 2023 14:53:04 +0200 Subject: [PATCH] Improve the bug report template. --- .github/ISSUE_TEMPLATE/bug_report.md | 33 ++++++++++++++++++---------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2d708d69e..ca14f3843 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,30 +9,41 @@ assignees: '' The following template contains guiding questions that should help you provide as much helpful information as possible. -You don't have to follow the template - it's meant to be deleted. Instead, just write the bug report and check this template to see if the bug report answers all the relevant questions. Don't worry if you don't know some answers; we will help you find them if needed. +You don't have to follow the template, you can just write the bug report and check this template to see if the bug report answers all the relevant questions. Don't worry if you don't know some answers; we will help you find them if needed. ## Questions: -What is the problem? For example: +### What is the problem? + +For example: - a crash - a warning - the generated code is incorrect, missing, etc. -When does the problem occur? For example: +Don't forget to describe the problem in more detail. + +For crashes, please include the error message and the stack trace. (To get a stack trace from a Gradle task, you might need to use the `--stacktrace` parameter.) + +### When does the problem occur? + +For example: - During the Gradle's configuration phase (for example, after syncing the project) - During Kotlin Framework compilation (inside the link task that produces the framework) - During other Gradle tasks (other than the link task mentioned above) - During Swift compilation (when trying to use the generated Kotlin Framework) -Don't forget to describe the problem in more detail: -- For crashes, please include the error message and the stack trace. (To get a stack trace from a Gradle task, you might need to use the `--stacktrace` parameter.) +### How do we reproduce the issue? + +If the problem is related or caused by some specific Kotlin declaration (a class, enum, function, etc.), please include an example of such a declaration (implementation of functions does not matter for the vast majority of SKIE-related issues, so you omit it). + +For Gradle issues: If you can, please include relevant parts of the `build.gradle` file. Usually, the relevant parts are the SKIE plugin and Kotlin Multiplatform plugin configuration - including the code that sets up targets and frameworks. + +### What has changed since the last time SKIE worked in your project? -How do we reproduce the issue? -- If the problem is related or caused by some specific Kotlin declaration (a class, enum, function, etc.), please include an example of such a declaration (implementation of functions does not matter for the vast majority of SKIE-related issues, so you omit it). -- For Gradle issues: If you can, please include relevant parts of the `build.gradle` file. Usually, the relevant parts are the SKIE plugin and Kotlin Multiplatform plugin configuration - including the code that sets up targets and frameworks. +Or: Did this issue occur during your first build after adding SKIE? -Did this issue occur during your first build after adding SKIE? If not, what has changed since the last time SKIE worked? +### What versions of SKIE, Kotlin, and Gradle do you use? -What versions of SKIE, Kotlin, and Gradle do you use? +### What is your SKIE Gradle configuration? -What is your SKIE Gradle configuration? (the content of the `skie {}` block in your `build.gradle` file) + (the content of the `skie {}` block in your `build.gradle` file)