diff --git a/.github/ISSUE_TEMPLATE/bug_report_template.yml b/.github/ISSUE_TEMPLATE/bug_report_template.yml index 12f878480..68bbaa61a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_template.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_template.yml @@ -10,6 +10,14 @@ body: options: - label: I have searched the existing issues required: true +- type: checkboxes + attributes: + label: Did you read the "Reporting a bug" section on Contributing file? + description: If you don't read, please take a moment to do it and avoid your report being closed. You can find it at [CONTRIBUTING.md](https://github.com/CommunityToolkit/Maui/blob/main/CONTRIBUTING.md#reporting-a-bug). + + options: + - label: I have read the "Reporting a bug" section on Contributing file. + required: true - type: textarea attributes: label: Current Behavior diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d551c7001..d77b2e8fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,6 +44,19 @@ We will take appropriate actions and measures if necessary. You will need to complete a Contribution License Agreement before any pull request can be accepted. Complete the CLA at https://cla.dotnetfoundation.org/. This will also be triggered whenever you open a PR and the link should guide you through it. +## Reporting a bug + +If you found something that looks like a bug don't hesitate in opening an issue reporting it. We strongly recommend you to follow our template, if you don't follow your issue can be closed, and that's because we don't have a lot of resources, so we will focus on issues that have most information that we need to work with. And, we would say, the most important part is the reproduction sample that shows the bug. + +### Bug reproduction + +We always request a reproduction sample, and that's not to make your life hard or anything like that... The reason of having a reproduction is to save us time to indentify and fix the bug. Create a new project; download the MCT NuGet; write UI; ViewModel; create a service; run it. As you can see it's a lot of timing consuming for us that we could spend fixing the actual issue. So **PLEASE** create a small reproduction project, upload it on GitHub or GitLab and paste the link in the issue. + +> We don't accept `.zip` files as reproduction samples, for security reasons. So if you send us a `.zip` file we will kindly ask you to upload it to GitHub or GitLab and share the link + +And most important: **Please, help us to help you ❤️** + + ## Opening a PR process ### TL;DR